--- title: Younium API Integration on Truto slug: younium category: Subscription Platform canonical: "https://truto.one/integrations/detail/younium/" --- # Younium API Integration on Truto **Category:** Subscription Platform **Status:** Beta ## MCP-ready AI tools Truto exposes 161 tools for Younium that AI agents can call directly. - **get_single_younium_account_by_id** — Get a single account in younium by its uuid id. Returns the account record with its id and content-type-specific account attributes. Required: id. - **update_a_younium_account_by_id** — Edit an existing account in younium by its uuid id. Returns an empty 200 response on success. Required: id. - **list_all_younium_accounts** — List accounts in younium, returning one account record per account with its id and content-type-specific account attributes. Supports Filter and OrderBy query parameters. - **create_a_younium_account** — Create a new account in younium. Returns an empty 201 response on success. Required: name, currency. - **delete_a_younium_account_by_id** — Delete a younium account by id. Returns an empty 200 response on success. Required: id. - **younium_accounts_subscriptions** — List the subscriptions belonging to a Younium account. Returns a paged list of subscription records, each with id and attributes holding the subscription-specific fields. Supports Filter, OrderBy and ModifiedBefore/After query parameters. Required: account_id. - **younium_accounts_payment_details_url** — Generate a Stripe payment details URL for a Younium account. Returns the URL where the account's payment details can be collected in attributes, and stores it on the account; no email is sent. Requires a request body identifying the account and an active Stripe connection. - **younium_accounts_request_payment_details** — Request GoCardless payment details for a Younium account, initiating the mandate flow for collecting the customer's bank details. Returns the mandate request status in attributes. Required: account_id. - **younium_accounts_summary** — Get summary and invoicing metrics for a Younium account. Returns the account's summary and invoicing metrics in attributes. Required: account_id. - **create_a_younium_accounts_online_payment_detail** — Create online payment details for a Younium account. Returns the created OnlinePaymentDetails record including its id and the payment-detail attributes defined by Younium's OnlineDetailsPayment schema. Required: account_id. - **update_a_younium_accounts_online_payment_detail_by_id** — Edit the online payment details of a Younium account by id, sending a merge-patch body that follows Younium's OnlinePaymentDetailsRequest schema. Returns an empty 204 response on success. Required: id. - **delete_a_younium_accounts_online_payment_detail_by_id** — Delete the online payment details of a Younium account by id. Returns an empty 204 response on success. Required: id. - **list_all_younium_invoices** — List invoices in Younium. Returns invoice records including id, status, invoiceLines, and customFields, with filter, sort, and modified-date window query parameters available. - **get_single_younium_invoice_by_id** — Get a single invoice in Younium by id. Returns the invoice record including its id, status, invoiceLines, and customFields; Younium omits fields that have no value from the response. Required: id. - **update_a_younium_invoice_by_id** — Edit an invoice in Younium by id with a JSON merge-patch body; only the fields included in the body are changed. Required: id. - **younium_invoices_cancel** — Cancel an invoice in Younium by id. Returns a 200 operation result confirming the cancellation; the fields of this operation response are not documented in Younium's API reference. Required: invoice_id. - **younium_invoices_attachments** — List attachments for an invoice in Younium by id. Returns a paged attachment list as an opaque payload whose individual fields Younium does not document; the generated URLs are valid for up to 24 hours by default. Required: invoice_id. - **younium_invoices_list_by_account** — List all invoices for a specific account in younium. Returns invoice records including id, created_at, and updated_at. Supports filtering (Filter, ModifiedAfter, ModifiedBefore) and sorting (OrderBy); max 100 records per page. Required: account_id. - **younium_invoices_create_from_order** — Generate an invoice from an order in younium. Returns the generated invoice record including id, created_at, and updated_at. Required: order_id. - **younium_invoices_create_on_account** — Generate an on-account invoice in younium. Returns the created invoice record including id, created_at, and updated_at. Required: currency. - **younium_invoices_credit** — Generate a credit invoice for an existing invoice in younium. Returns the generated credit invoice record including id, created_at, and updated_at. Required: invoice_id. - **younium_invoices_download_attachment** — Download an invoice attachment file by attachment id in younium. Returns the raw attachment file content rather than a JSON object. Required: downloadattachment_id. - **younium_invoices_generate_attachment_url** — Generate a signed, time-limited URL for the PDF attachment of a posted Younium invoice. Returns the URL itself as a URI string, valid for up to 24 hours by default. Required: generateattachmenturl_id. - **younium_invoices_invoice_download_attachment** — Download the PDF attachment generated from the document template when a Younium invoice was posted. Returns the raw PDF file (binary content). Required: invoicedownloadattachment_id. - **younium_invoices_online_payment_logs** — List online payment logs for a Younium invoice. Supports OData-style filtering, sorting, and modified-date filters. Returns a paged collection of online payment log records. Required: invoice_id. - **younium_invoices_paid** — Mark a posted Younium invoice as paid in another system. Requires a request body identifying the invoice to mark as paid (InvoicePaidRequest). Returns no response body on success. Required: invoiceId. - **younium_invoices_post** — Post a Younium invoice, moving it into its posted state (fires the InvoicePosted webhook). Returns an OperationResponse describing the outcome of the post operation. Required: invoice_id. - **younium_invoices_posted_document_attachments** — List invoice attachments for posted invoice documents in Younium, each with a shared-access (SAS) download URL valid for up to 24 hours. Returns: pageNumber, pageSize, totalPages, totalCount, nextPage, previousPage, firstPage, lastPage, data. - **younium_invoices_related** — List the invoices related to a specified Younium invoice. Returns: pageNumber, pageSize, totalPages, totalCount, nextPage, previousPage, firstPage, lastPage, data. Required: invoice_id. - **list_all_younium_sales_orders** — List Younium sales orders with filtering, sorting, and modified-date scoping. Returns each record's id, orderProducts, orderCharges, and milestones. Max 100 records per page. - **create_a_younium_sales_order** — Create a Younium sales order. Returns the created sales order including id, orderProducts, orderCharges, and milestones. Request body must follow the CreateSalesOrderRequest schema. Required: account. - **get_single_younium_sales_order_by_id** — Get a single Younium sales order by id. Returns the sales order's id, orderProducts, orderCharges, and milestones. Required: id. - **younium_sales_orders_activate** — Activate a Younium sales order by id; returns 200 with the EventResponse object (eventId, description, timestamp, success). Required: sales_order_id. - **younium_sales_orders_list_by_account** — List the Younium sales orders of a specific account. Returns each record's id, orderProducts, orderCharges, and milestones. Required: account_id. - **younium_sales_orders_version** — Get the version of a Younium sales order by sales order id. Returns the versioned sales order record including its id and content-type-specific attributes (nested orderProducts, orderCharges, orderDiscounts, milestones, and customFields). Required: salesorder_id. - **younium_sales_orders_version_by_number** — Get a specific version of a Younium sales order by order number and version number. Returns the versioned sales order record including its id and content-type-specific attributes (nested orderProducts, orderCharges, orderDiscounts, milestones, and customFields). Required: order_number, version_id. - **younium_sales_orders_versions** — List all versions of a Younium sales order by order number. Returns a collection of versioned sales order records, each with its id and content-type-specific attributes (nested orderProducts, orderCharges, orderDiscounts, milestones, and customFields). Required: order_number. - **get_single_younium_booking_by_id** — Get a Younium booking by id. Returns the booking record including its id (UUID) and its bookingLines. Required: id. - **update_a_younium_booking_by_id** — Update a Younium booking by id using a merge-patch request body. Returns an empty 204 response on success. Required: id. - **list_all_younium_bookings** — List Younium bookings. Supports Filter expressions (including customFieldEq/customFieldExist), OrderBy sorting, and ModifiedAfter/ModifiedBefore filters (ModifiedBefore also applies to bookingLines). Returns booking records including id and bookingLines. - **get_single_younium_chart_of_account_by_id** — Get a single chart of accounts financial account in younium by id. Returns the financial account record including its id (UUID) and accountNumber. Required: id. - **list_all_younium_chart_of_accounts** — List the chart of accounts financial accounts in younium. Returns a paged collection of financial account records, each including its id (UUID) and accountNumber. Max 100 records per page. - **list_all_younium_countries** — List countries in Younium. Returns a paged collection of country records including id, name, and modified. Max 100 records per page. - **get_single_younium_country_by_id** — Get a single country in Younium by id (UUID). Returns the country record including id, name, and modified. Required: id. - **list_all_younium_currency_base_currencies** — Get the base currency configured for the younium tenant. Returns the Currency record of the tenant's base currency, including its id. - **list_all_younium_currencies** — List currencies in Younium. Returns a paged collection of currency records, each including its id. Max 100 records per page. - **create_a_younium_currency** — Create a currency in Younium. Returns the created currency object including its id. Required: code. - **get_single_younium_currency_by_id** — Get a single Younium currency by id. Returns the currency object including its id. Required: id. - **delete_a_younium_currency_by_id** — Delete a Younium currency by id. Returns an empty 200 response on success. Required: id. - **list_all_younium_custom_field_configurations** — List younium custom field configurations, optionally filtered (Filter supports the customFieldEq and customFieldExist functions), sorted via OrderBy, or bounded by ModifiedAfter/ModifiedBefore. Returns a paged collection of configuration records, each with its id and name. - **create_a_younium_custom_field_configuration** — Create a custom field configuration in younium. Returns the created configuration record with its id and name. Requires a request body (upstream schema CreateCustomFieldConfigurationRequest). Required: fieldType. - **get_single_younium_custom_field_configuration_by_id** — Get a single younium custom field configuration by its id (UUID). Returns the configuration record with its id and name. Required: id. - **update_a_younium_custom_field_configuration_by_id** — Update an existing custom field configuration in younium by its id (UUID) using a merge-patch request body. Returns an empty 200 response on success. Required: id. - **younium_custom_field_configurations_bulk_update** — Update a custom field configuration in younium by entity and key using a merge-patch request body, addressing the configuration without its id. Returns an empty 200 response on success. Required: entity, key. - **younium_custom_field_configurations_get_by_key** — Get a single custom field configuration in Younium by entity and key. Returns: id, key, name, defaultValue, fieldType, entity, list, typeEntity, entityObject, clientId, secret. Required: entity, customfieldconfiguration_id. - **get_single_younium_document_template_by_id** — Get a single Younium document template by its id. Returns the template record with its id (uuid) and template-specific attributes; only fields containing values are included in the response. Required: id. - **list_all_younium_document_templates** — List Younium document templates. Returns a paged collection of template records with id and template-specific attributes; supports Filter (including customFieldEq/customFieldExist functions), OrderBy sorting, and ModifiedAfter/ModifiedBefore date narrowing. - **list_all_younium_exchange_rates** — List Younium exchange rates. Returns exchange rate records, each identified by its id (UUID). - **create_a_younium_exchange_rate** — Create a new exchange rate in Younium with a CreateExchangeRateRequest body. Returns an empty 201 response on success. Required: fromCurrency, rate, effectiveFromDate. - **get_single_younium_exchange_rate_by_id** — Get a single Younium exchange rate by id. Returns the exchange rate record, identified by its id (UUID). Required: id. - **list_all_younium_posteds** — Get the status of a posted invoice batch job in younium. Returns the batch job status details (PostedBatchJobStatusResponse) for the post job, so you can confirm whether posting finished, is running, or failed. Required: batch_reference. - **list_all_younium_invoice_batches** — List invoice batches in Younium. Returns a paged collection of invoice batch records including id, created_at, and updated_at. - **create_a_younium_invoice_batch** — Generate an invoice batch in Younium by running the generate invoice batch job. Returns the job response including id, created_at, and updated_at. Generation runs asynchronously; job status can be polled via the batch job status endpoints. - **get_single_younium_invoice_batch_by_id** — Get a single invoice batch in Younium by id. Returns the batch record including id, created_at, and updated_at. Required: id. - **younium_invoice_batches_batch_log** — Get the processing log for an invoice batch in Younium by batch id or reference. Returns log entries including id, created_at, and updated_at. Required: batch_identifier. - **younium_invoice_batches_generated** — Get the status of a generate invoice batch job in Younium. Returns the job status record including resultBody, resultStatus, and statusMessage. Required: batch_reference. - **younium_invoice_batches_post** — Post an invoice batch in Younium by starting the post invoice batch job. Returns the job response with id, jobId, and batchNumber; the id can be used to check the job via the batch job status endpoints. The job runs asynchronously; status is also visible in settings > scheduled jobs in the Younium UI. Required: invoice_batch_id. - **list_all_younium_invoice_batch_groups** — List invoice batch groups in younium. Returns: id, code, description, created_at, updated_at. Supports the Filter parameter (including custom-field functions customFieldEq/customFieldExist) and OrderBy sorting. - **get_single_younium_invoice_batch_group_by_id** — Get a single invoice batch group in younium by id. Returns: id, code, description, created_at, updated_at. Required: id. - **get_single_younium_invoices_usage_by_id** — Get the invoices generated for a specific usage record in Younium. Returns a paged collection of invoice records with fields including id, invoiceNumber, account, invoiceDate, dueDate, currency, totalAmount, and invoiceLines. Required: id. - **create_a_younium_process_stripe_payment** — Process a Stripe payment for an invoice in younium. Returns the payment processing result payload (ProcessedOnlinePaymentResponse) including its id and status; the payload's remaining fields are not enumerated in Younium's documentation. Invoices whose online payment status is 'Succeeded' or 'Processing' are not reprocessed. Required: invoice_id. - **get_single_younium_journal_by_id** — Get a single Younium journal by id. Returns the journal record including its id (UUID) and description. Required: id. - **update_a_younium_journal_by_id** — Patch an existing Younium journal by id with a merge-patch JSON body. Returns the updated journal record including its id (UUID). Required: id. - **list_all_younium_journals** — List journals in Younium. Returns a paged collection of journal records, each including its id (UUID) and description. - **younium_journals_accounting_transactions** — List accounting transactions for a specific Younium journal. Returns a paged collection of transaction records including transactionNumber, effectiveDate, transactions, and the related invoice. Required: journal_id. - **younium_journals_accounting_transactions_by_year** — List Younium accounting transactions for a fiscal year. Returns a paged collection of transaction records including transactionNumber, effectiveDate, transactions, and the related invoice. Required: year. - **younium_journals_fiscal_periods** — Get accounting transactions in younium for a fiscal year and period. Returns: transactionNumber, effectiveDate, source, transactions, orderChargeNumber, orderChargeId, revenueScheduleItemId, invoice, invoiceAccountId, invoiceId, invoiceLineId, paymentId, paymentSettlementId, invoiceAccount, journalId, externalERPId, externalCRMId, created, modified. Required: year, period. - **younium_journals_fiscal_quarters** — Get accounting transactions in younium for a fiscal year and quarter. Returns: transactionNumber, effectiveDate, source, transactions, orderChargeNumber, orderChargeId, revenueScheduleItemId, invoice, invoiceAccountId, invoiceId, invoiceLineId, paymentId, paymentSettlementId, invoiceAccount, journalId, externalERPId, externalCRMId, created, modified. Required: year, quarter. - **younium_journals_financial_accounts** — Get accounting transactions in younium for a fiscal year and a specific financial account. Returns: transactionNumber, effectiveDate, source, transactions, orderChargeNumber, orderChargeId, revenueScheduleItemId, invoice, invoiceAccountId, invoiceId, invoiceLineId, paymentId, paymentSettlementId, invoiceAccount, journalId, externalERPId, externalCRMId, created, modified. Required: year, financial_account. - **younium_journals_journal_details** — Get journal detail records in younium, with optional filtering and sorting. Returns: id, journalNumber, accountingPeriod, journalType, description, posted, postedDate, externalERPId, transferredToERP, created, modified. - **younium_journals_journal_summary** — Get the summary for a journal in younium by journal id. Returns: summaryLines, id, journalNumber, accountingPeriod, journalType, description, posted, postedDate, externalERPId, transferredToERP, created, modified. Required: journal_id. - **list_all_younium_measurements** — List measurements in Younium with paging (max 100 records per page). Returns measurement records, each including its id (uuid). - **create_a_younium_measurement** — Create a measurement in Younium by posting a measurement JSON payload. Returns the created measurement including its id. Required: fromDate. - **get_single_younium_measurement_by_id** — Get a single measurement in Younium by its id. Returns the measurement record including its id (uuid). Required: id. - **younium_measurements_import** — Import measurement data into Younium in bulk using CSV or JSON format. Returns an import result object whose fields follow Younium's ImportDataResponse schema. Required: mappingTemplateName, data. - **get_single_younium_order_by_id** — Get any version of a sales order or subscription in Younium by id. Returns the full order object — either a SalesOrderResponse or a SubscriptionResponse depending on the record type the id resolves to — with record-type-specific fields. Required: id. - **get_single_younium_orders_charge_by_id** — Get an order product charge from a subscription or sales order in Younium by id, including any version of the charge. Returns the charge's id, name, and chargedThroughDate (the invoiced-to date). Required: id. - **update_a_younium_orders_charge_by_id** — Update an order product charge in Younium by id with a merge-patch body. Returns the updated charge's id, name, and chargedThroughDate. Required: id. - **younium_orders_charges_invoiced_to** — Set the invoiced-to date on an order product charge in Younium. The date cannot be before the charge's effective start date or the current invoiced-to date. Returns an empty 204 response on success. Required: charge_id. - **list_all_younium_charges** — List the charges of a Younium order by order id. Returns a paged collection of order product charge records, each with an id and a chargedThroughDate (the charge's invoiced-to date); remaining record fields are schema-defined upstream. Max 100 records per page. Required: order_id. - **younium_charges_list_by_product** — List the charges of a Younium order product by product id. Returns a paged collection of order product charge records, each with an id and a chargedThroughDate (the charge's invoiced-to date); remaining record fields are schema-defined upstream. Max 100 records per page. Required: product_id. - **list_all_younium_payments** — List younium payments with optional filtering, sorting, and modified-date bounds. Returns payment records including id, paymentSettlements, and writeOffs. Filter supports customFieldEq and customFieldExist functions combined with and. - **create_a_younium_payment** — Create a payment in younium by submitting a JSON payment request body. Returns the created payment record including id, paymentSettlements, and writeOffs. Required: paymentMethod. - **get_single_younium_payment_by_id** — Get a single younium payment by id (uuid). Returns: id, reference, description, amount. Required: id. - **update_a_younium_payment_by_id** — Update a Younium payment by id, editing its details and adding, removing, or editing its payment settlements and write offs. Returns an empty 204 response on success. Required: id. - **younium_payments_create_and_post** — Create a Younium payment and post it in a single operation. Returns the EventResponse acknowledgment for the created-and-posted payment event. Required: invoice, paymentMethod. - **list_all_younium_payment_terms** — List payment terms in Younium. Returns payment term records, each including its id, name, and description. - **create_a_younium_payment_term** — Create a payment term in Younium with a JSON body following the upstream CreatePaymentTermRequest schema. Returns the created payment term including its id. Required: description, name, days. - **get_single_younium_payment_term_by_id** — Get a payment term in Younium by id. Returns the payment term record including its id, name, and description. Required: id. - **list_all_younium_products** — List Younium products. Returns paged product records including id, name, chargePlans, charges, and customFields. Filter supports customFieldEq/customFieldExist (combinable only with and), results sort via OrderBy, and can be narrowed to a modified-date window with ModifiedAfter/ModifiedBefore. - **create_a_younium_product** — Create a product in Younium. Requires a JSON body following the upstream CreateProductRequest schema (the product definition, e.g. name). Returns a 201 Created event acknowledgement (EventResponse) including its id. - **get_single_younium_product_by_id** — Get a single Younium product by id (uuid). Returns the product record including id, name, chargePlans, charges, and customFields. Required: id. - **update_a_younium_product_by_id** — Update a Younium product by id (uuid) using a JSON merge patch body following the upstream UpdateProductRequest schema; only the fields provided are changed. Returns an empty 204 response on success. Required: id. - **delete_a_younium_product_by_id** — Delete a Younium product by id (uuid). A product can only be deleted while it is not in use on any active orders. Returns an empty 200 response on success. Required: id. - **younium_products_from_charge** — Get the Younium product that contains a specific charge by supplying the charge's id. Returns the product record including its id, name, charge plans, charges, and custom fields. Required: fromcharge_id. - **younium_products_from_charge_plan** — Get the Younium product that contains a specific charge plan by supplying the charge plan's id. Returns the product record including its id, name, charge plans, charges, and custom fields. Required: fromchargeplan_id. - **younium_products_product_features** — List product features in Younium. Returns a paged collection of product feature records, each identified by its id. Supports Younium filter syntax (including customFieldEq/customFieldExist functions), ordering, and modified-before/after windowing. - **update_a_younium_products_charge_by_id** — Update a charge in younium by id. Returns an empty 204 response on success. The request body is a JSON merge-patch document per Younium's PatchChargeRequest schema. Required: id. - **delete_a_younium_products_charge_by_id** — Delete a charge in younium by id. Returns an empty 204 response on success. A charge can only be deleted if it is not in use on any active orders. Required: id. - **delete_a_younium_products_charge_plan_by_id** — Delete a charge plan in Younium by id. A charge plan can only be deleted if it is not in use on any active orders. Returns an empty 204 response on success. Required: id. - **list_all_younium_quotes** — List Younium quotes, with support for filtering (including custom-field functions), sorting, and modified-date windows. Returns each quote's: id, products, customFields. - **get_single_younium_quote_by_id** — Get a single Younium quote in Younium by its id (UUID). Returns: id, number, version, status, description, customer, currency, remarks, tcv, cmrr, acv, otf, created, modified, products. Required: id. - **younium_quotes_convert_to_order** — Convert a Younium quote into a new order — an order draft by default, or an active order when activateOrder is true. Returns: quoteId, quoteNumber, quote, orderId, orderNumber, orderType, orderStatus. The quote can only be identified by its id or a unique custom field; attachments carry over to the order, notes do not. Required: quote. - **list_all_younium_reports** — List the reports available in Younium. Returns a paged list of report records, each including its id (UUID). Supports filtering, sorting, and modified-date filtering. Max 100 records per page. - **get_single_younium_report_by_id** — Get a single Younium report by id. Returns the report record including its id (UUID). Required: id. - **younium_reports_data** — Get the data rows of a Younium report. Returns paged report data rows — objects whose keys are the report's field names, so the row shape depends on the report's definition. Max 100 rows per page. Required: report_id. - **list_all_younium_simple_products** — List simple products in Younium. Returns a paged collection of simple product records, each including its id and name; results can be filtered (including by custom field) and sorted. - **get_single_younium_simple_product_by_id** — Get a single simple product in Younium by id. Returns the simple product record, including its id and name. Required: id. - **get_single_younium_subscription_by_id** — Get a single Younium subscription by its UUID id. Returns the subscription record including id, status, orderNumber, effectiveStartDate, cmrr, and sub-entity collections such as orderProducts, orderCharges, milestones, and customFields. Required: id. - **update_a_younium_subscription_by_id** — Patch a Younium subscription by id with a JSON merge-patch body (PatchSubscriptionRequest) containing only the fields to update. Returns the updated subscription record including id, status, orderNumber, effectiveStartDate, and cmrr. Required: id. - **delete_a_younium_subscription_by_id** — Delete a Younium subscription by id. Returns an empty 200 response on success. Required: id. - **list_all_younium_subscriptions** — List Younium subscriptions with OData-style Filter, OrderBy sorting, and ModifiedAfter/ModifiedBefore date filters. Returns subscription records including id, status, orderNumber, effectiveStartDate, cmrr, and sub-entity collections such as orderProducts, orderCharges, and milestones. - **create_a_younium_subscription** — Create a Younium subscription from a CreateSubscriptionRequest body. Returns the created subscription record including id, status, orderNumber, effectiveStartDate, and cmrr. The body fields are defined by the CreateSubscriptionRequest schema in Younium's API reference. Required: status, account. - **younium_subscriptions_activate** — Activate a subscription in younium. Returns the upstream event-acknowledgement (EventResponse) object, whose fields are not enumerated in the available documentation. Required: subscription_id. - **younium_subscriptions_cancel** — Cancel a subscription in younium, supplying cancellation details in a JSON body. Returns an empty 200 response on success. Required: subscription_id, cancellationDate, cancellationMode. - **younium_subscriptions_change** — Apply a change to a subscription in younium by id, creating a new subscription version from a JSON change request body. Returns an empty 201 response on success ("New version of Subscription created."). Required: subscription_id. - **younium_subscriptions_renew** — Renew a subscription in younium, supplying renewal details in a JSON body. Returns an empty 200 response on success. Required: subscription_id, renewalTerm. - **younium_subscriptions_renew_and_change** — Renew a subscription and apply a change in a single transaction in younium, reverting the renewal if the change fails. Specify the renewal with the renewal-term fields of the JSON body; other body properties apply to the change. Returns the upstream event-acknowledgement (EventResponse) object, whose fields are not enumerated in the available documentation. Required: subscription_id. - **younium_subscriptions_revert** — Revert a Younium subscription by id. Returns: id, message. Required: subscription_id. - **younium_subscriptions_set_milestone** — Set the milestone date on a Younium subscription milestone by milestone id. Returns: id, orderId, name, description, milestoneDate, plannedDate. Required: milestone_id, milestoneDate. - **younium_subscriptions_set_order_discount** — Edit and create order discounts on an existing Younium subscription order, creating a new version of the order. Returns an empty 204 response on success. Required: subscription_id. - **younium_subscriptions_version** — Get a single version of a Younium subscription by subscription id. Returns the subscription version record including: id, orderNumber, version, isLastVersion, status, description, effectiveStartDate, effectiveEndDate, term, renewalTerm, isAutoRenewed, currency, account, products, milestones, and orderDiscounts. Required: subscription_id. - **younium_subscriptions_versions** — List the versions of a Younium subscription by order number, with optional filter, sort, and modified-date bounds. Each item is a subscription version record including: id, orderNumber, version, isLastVersion, status, description, effectiveStartDate, term, renewalTerm, currency, account, products, milestones, and orderDiscounts. Required: order_number. - **younium_subscriptions_milestones** — List the milestones of a Younium subscription by subscription id. Returns the subscription's milestone records, each identified by id (the UUID used when setting a milestone date). Required: subscription_id. - **younium_subscriptions_version_by_number** — Get a specific version of a Younium subscription by order number. Returns the subscription version record including its id, orderNumber, and version. Required: order_number, version_id. - **list_all_younium_tax_templates** — List tax templates in Younium. Returns a paged collection of tax template records, each including its id. - **get_single_younium_tax_template_by_id** — Get a single tax template in Younium by id. Returns the tax template record including its id. Required: id. - **list_all_younium_unit_of_measurements** — List unit of measurements in Younium. Returns a paged collection of unit of measure records, each identified by its id. Supports optional Filter, OrderBy, and ModifiedAfter/ModifiedBefore parameters; page size is capped at 100 records. - **get_single_younium_unit_of_measurement_by_id** — Get a single unit of measurement in Younium by id. Returns the unit of measure record including its id. Required: id. - **list_all_younium_usages** — List usage records in Younium. Returns a paged collection of usage records, each identified by id with the remaining record fields. Supports Filter (including customFieldEq/customFieldExist), OrderBy sorting, and ModifiedAfter/ModifiedBefore time-window filters. - **create_a_younium_usage** — Create a usage record in Younium by posting the usage payload as JSON. Returns the created usage record with its id and remaining record fields. Supports an optional idempotency key. Required: fromDate. - **get_single_younium_usage_by_id** — Get a single usage record from Younium by id (UUID). Returns the usage record with its id and remaining record fields. Required: id. - **update_a_younium_usage_by_id** — Update a usage record in Younium by id (UUID) using a JSON merge-patch body. Returns an empty 204 response on success. Required: id. - **delete_a_younium_usage_by_id** — Delete a usage record from Younium by id (UUID). Returns an empty 200 response on success. Required: id. - **younium_usages_import** — Import usage data into Younium in CSV or JSON format. Returns the import result object with the fields defined by the upstream ImportDataResponse schema. Requires a request body following the ImportUsageRequest schema. Required: mappingTemplateName, data. - **list_all_younium_users** — List Younium users for the current tenant. Returns: roles, id, firstName, lastName, title, culture, email, userName, active, isLegacyApiUser. - **get_single_younium_user_by_id** — Get a Younium user by id. Returns: roles, id, firstName, lastName, title, culture, email, userName, active, isLegacyApiUser. Required: id. - **younium_users_by_role** — List the Younium users that hold a given role, including their roles across all legal entities. Returns: roles, id, firstName, lastName, title, culture, email, userName, active, isLegacyApiUser. Required: role_id. - **create_a_younium_role** — Assign a role to a Younium user by user id. Returns the user-with-roles object including its id and the updated roles collection. Required: user_id, role. - **delete_a_younium_role_by_id** — Remove a role assignment from a Younium user. The user must retain at least one role after the deletion. Returns an empty response on success. Required: id, user_id. - **get_single_younium_role_by_id** — Get a single Younium user role by id. Returns the role with its id, name, and permissions. Required: id. - **list_all_younium_roles** — List Younium user roles available to the tenant. Returns each role with its id, name, and permissions. - **list_all_younium_webhooks** — List Younium webhooks. Returns: id, url, events, token, description, webhookStatus. - **create_a_younium_webhook** — Create a Younium webhook subscription that delivers events to your service URL. Returns: id, url, events, token, description, webhookStatus. Required: url, events. - **get_single_younium_webhook_by_id** — Get a Younium webhook by id. Returns the webhook record: id, url, events, token, webhookStatus. Required: id. - **delete_a_younium_webhook_by_id** — Delete a Younium webhook by id. Returns an empty 204 response on success. Required: id. - **create_a_younium_auth_token** — Generate a Younium API JWT access token by exchanging client credentials. Returns: access_token, refresh_token, expires_in, expires. Requires clientId and secret. The access token is valid for 24 hours; request a new token once it expires. - **younium_metrics_calculate_charge** — Calculate metrics from charge data in Younium. Sends a charge payload in the request body and returns the computed charge metrics object defined by Younium's ChargeMetricsResponse schema (the upstream docs do not enumerate its fields). Requires a JSON body of charge data. - **younium_metrics_calculate_order** — Calculate metrics from order data in Younium. Sends an order payload in the request body and returns the computed order metrics object defined by Younium's OrderMetricsResponse schema (the upstream docs do not enumerate its fields). Requires a JSON body of order data. - **younium_revenue_schedules_get_by_invoice_line** — Get the revenue schedules for a Younium invoice line. Returns a paged list of revenue schedule records with id, deferred and recognized revenue, accountingPeriod, invoiceLine, and orderProductCharge. Required: invoiceline_id. - **younium_revenue_schedules_list_by_charge_number** — List the revenue schedules for a Younium charge by its charge number. Returns a paged list of revenue schedule records with id, deferred and recognized revenue, accountingPeriod, invoiceLine, and orderProductCharge. Required: charge_number. ## How it works 1. **Link your customer's Younium account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Younium.** The Proxy API is a 1-to-1 mapping of the Younium API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Embed subscription billing into CRM and RevOps tools** — Give sales and RevOps teams the ability to convert closed deals into active Younium subscriptions without leaving your product. Pull CMRR, renewal dates, and contract versions to power pipeline forecasting and expansion analytics. - **Power usage-based billing from product telemetry** — Let your customers stream metered events, feature consumption, or data warehouse aggregates into Younium so their invoices reflect actual usage. Ideal for data pipeline tools, analytics platforms, and PLG infrastructure. - **Surface billing data in Customer Success platforms** — Pull invoice status, payment logs, and subscription versions so CSMs can spot at-risk accounts, flag involuntary churn from failed payments, and track expansion MRR across the renewal cycle. - **Automate commission calculations with audited revenue** — Commission and incentive tools can read posted invoices, subscription version diffs, and paid status directly from Younium to pay reps on booked or collected revenue instead of CRM deal stages. - **Build white-labeled customer billing portals** — Let your end users view invoices, download PDFs, update payment details, and request subscription changes from inside your app — without exposing them to Younium's UI. ## What you can build - **Subscription lifecycle controls** — Create, change, renew, cancel, and revert subscriptions programmatically to support upgrades, downgrades, and mid-cycle amendments triggered from your product. - **Usage and measurement ingestion pipeline** — Push metered events or batch usage files into Younium via the usage and measurement import endpoints so invoices reflect real consumption at close of period. - **Embedded invoice viewer with PDF download** — List invoices by account, fetch invoice details, and generate attachment URLs so users can view and download their billing documents inside your UI. - **Stripe payment collection flow** — Generate payment detail collection links, store online payment details, and trigger Stripe charges from your app using the process Stripe payment endpoint. - **Quote-to-order automation** — Convert Younium quotes into sales orders and activate them to provision subscriptions the moment a deal is closed in your product. - **Revenue and journal sync to the data warehouse** — Extract posted journal entries, accounting transactions, and revenue schedules per invoice line to feed finance dashboards, ERPs, or reverse ETL destinations. ## FAQs ### How does authentication work for connecting a user's Younium account? Younium uses token-based authentication. Truto handles the auth token exchange via the create auth token flow and manages token storage and refresh so your end users complete a one-time connection without you handling credentials directly. ### Can we push usage data in bulk for usage-based billing? Yes. In addition to creating individual usage records, Younium supports batch ingestion through the usages import and measurements import endpoints, which is the recommended path for syncing aggregated usage from data warehouses or product databases. ### Does the integration support custom fields on Younium objects? Yes. You can list, create, read, and bulk-update custom field configurations, and fetch configurations by key, so your product can read and write customer-defined fields on accounts, subscriptions, and other objects. ### Can we track changes to a subscription over time? Yes. Younium exposes subscription versions, version-by-number lookups, and milestones, which let you reconstruct the history of amendments, upgrades, and renewals — useful for commission calculations and MRR movement analysis. ### How do we handle invoice generation and posting? You can create invoices from an order or directly on an account, post them to make them live, cancel or credit them, and mark them paid. Invoice batches are also supported for high-volume billing runs. ### Can we receive real-time updates from Younium instead of polling? Yes. Younium supports webhooks, and you can list, create, retrieve, and delete webhook subscriptions through the integration to receive event-driven updates on subscriptions, invoices, and payments.