Create subscription
Create a new subscription and assign it to a customer.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Strategy used to activate the subscription.
start_date: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.manually: The subscription requires activation through a manual action.checkout: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.quote: The subscription will be activated depending on the configuration and the signature of the related quote.
start_date, manually, checkout ID of the customer.
Set the allowed types of payment methods for the customer. Only applies to the new payment method strategy.
card, direct_debit, direct_debit_ach, direct_debit_bacs, transfer, transfer_automated Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.
Strategy used to cancel the subscription. If not specified do_nothing is used.
charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.charge_custom: Will charge the customer a custom amount.refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.refund_custom: Will refund to the customer a custom amount.end_of_period: Will cancel the subscription at the end date of the current billing period.do_nothing: Will only cease the subscription without any additional actions.
refund_prorata, refund_custom, charge_prorata, charge_custom, end_of_period, do_nothing Use contract_start contract_end and renew_automatically instead. Interval previously used to represent the commitment period of the subscription.
Subscription contract start date. UTC date time string in the ISO 8601 format.
[On demand] Will split the subscription into 2 phases, one will contain 'once' products and the other the recurring ones. Call next-phase endpoint to transition between the 2 phases.
A list of key value with the ID or the name of the custom property as the key and the custom property value as value.
Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent
Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.
ID of the invoicing entity attached to the subscription.
Minimum fee applied to each invoice outside of one time payments.
Payment method strategy used to bill the subscription. By default, the current payment method of the customer will be used.
new: Ask the customer for a new payment method. The customer can fill in their payment method either on the subscription's checkout session or on their portal page.current: Use the current default payment method of the customer.external: Manage the payments of the subscription outside of Hyperline.
current, external, new ID of the plan used to create the subscription.
Products that make up the subscription.
Key/value pairs to store any information you find useful.
Reference to the purchase order.
Indicates if the subscription should automatically renew.
If renew_automatically is enabled, will renew the subscription for the given interval.
Deprecated field, please use contract_start.
Delay first invoice to the end of the trial period.
Response
Strategy used to activate the subscription.
start_date: The subscription will become active on the specified start date. If the start date is in the past, it will be activated immediately.manually: The subscription requires activation through a manual action.checkout: The subscription will be activated once the checkout is completed, but only if the start date is in the past. Otherwise, activation will occur later on the specified start date.quote: The subscription will be activated depending on the configuration and the signature of the related quote.
start_date, manually, checkout, quote, contract_start_date Subscription cancel date. UTC date time string in the ISO 8601 format.
Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.
Strategy used to cancel the subscription. If not specified do_nothing is used.
charge_prorata: Will charge the customer the unpaid amount for the prorated period up to the end of the current period.charge_custom: Will charge the customer a custom amount.refund_prorata: Will refund to the customer the overpaid subscription amount using prorated calculations on the cancellation date.refund_custom: Will refund to the customer a custom amount.end_of_period: Will cancel the subscription at the end date of the current billing period.do_nothing: Will only cease the subscription without any additional actions.
refund_prorata, refund_custom, charge_prorata, charge_custom, end_of_period, do_nothing Checkout session of the subscription.
ID of the checkout session.
Use contract_start contract_end and renew_automatically instead. Interval previously used to represent the commitment period of the subscription.
Subscription contract end date. UTC date time string in the ISO 8601 format.
Subscription contract start date. UTC date time string in the ISO 8601 format.
Coupons to be applied to the prices of subscription products.
ID of the related opportunity/deal in the connected CRM.
Currency code. See ISO 4217.
EUR, AED, AFN, XCD, ALL, AMD, AOA, ARS, USD, AUD, AWG, AZN, BAM, BBD, BDT, XOF, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, NOK, BWP, BYR, BZD, CAD, CDF, XAF, CHF, NZD, CLP, CNY, COP, CRC, CUP, CVE, ANG, CZK, DJF, DKK, DOP, DZD, EGP, MAD, ERN, ETB, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MDL, MGA, MKD, MMK, MNT, MOP, MRO, MUR, MVR, MWK, MXN, MYR, MZN, NAD, XPF, NGN, NIO, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STD, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, UYU, UZS, VEF, VND, VUV, WST, YER, ZAR, ZMW, ZWL End date of the current billing period. UTC date time string in the ISO 8601 format.
Start date of the current billing period. UTC date time string in the ISO 8601 format.
ID of the current subscription phase.
A list of key value with the ID or the name of the custom property as the key and the custom property value as value.
ID of the customer.
Estimated Annual Recurring Revenue generated by the subscription.
Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent
Subscription ID.
Date when the subscription will start being billed. If not specified, it will correspond to the contract_start date. UTC date time string in the ISO 8601 format.
ID of the invoicing entity attached to the subscription.
Minimum fee applied to each invoice outside of one time payments.
The amount of the next subscription payment. The system will generate an invoice to pay on the next_payment_at.
Date on which the next subscription payment will occur. UTC date time string in the ISO 8601 format.
Date when the subscription was paused. Only applies to paused status. UTC date time string in the ISO 8601 format.
Payment method details used to pay the subscription.
Payment method type used to pay the subscription.
card, direct_debit, direct_debit_ach, direct_debit_bacs, transfer, transfer_automated, external ID of the plan used to create the subscription.
Products that make up the subscription.
Key/value pairs to store any information you find useful.
Reference to the purchase order.
Date when the subscription will be automatically reactivated. UTC date time string in the ISO 8601 format.
Indicates if the subscription should automatically renew.
If renew_automatically is enabled, will renew the subscription for the given interval.
Next subscription commitment renewal date. UTC date time string in the ISO 8601 format.
Deprecated field, please use contract_start.
Subscription status.
draft: The subscription is being created, this status is only used in the subscription assignation flow of the UI version of Hyperline.pending: The subscription has been created and won't be charged until it is activated.active: The subscription is running and will be invoiced at the next payment date.paused: The subscription's payment collection is paused.cancelled: The subscription has been canceled from an active state.voided: The subscription has been voided directly from the pending state.errored: We attempted 4 times (3 retries) and failed to charge a subscription's invoice, see Handling payment errors. We consider the subscription as inactive (as the customer failed to pay you) meaning that we won't invoice the customer in the future nor collect payment. You can choose to reactivate it manually.
active, cancelled, draft, errored, paused, pending, voided End date of the trial period. UTC date time string in the ISO 8601 format.
Was this page helpful?