POST
/
v1
/
subscriptions
/
{id}
/
cancel

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

application/json
cancel_at
string

UTC date time string in the ISO 8601 format.

pro_rata
boolean

Indicates if the cancel should refund the customer using a pro rata strategy.

Response

200 - application/json
id
string
required

Subscription ID.

currency
enum<string>
required

Currency code. See ISO 4217.

Available options:
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
status
enum<string>
required

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.
Available options:
active,
cancelled,
draft,
errored,
paused,
pending,
voided
purchase_order
string | null
required

Reference to the purchase order.

customer_id
string
required

ID of the customer.

plan_id
string | null
required

ID of the plan used to create the subscription.

invoicing_entity_id
string
required

ID of the invoicing entity attached to the subscription.

checkout_session_id
string | null
required

ID of the checkout session.

crm_opportunity_id
string | null
required

ID of the related opportunity/deal in the connected CRM.

minimum_invoice_fee
number | null
required

Minimum fee applied to each invoice outside of one time payments.

commitment_interval
object | null
requireddeprecated

Use contract_start contract_end and renew_automatically instead. Interval previously used to represent the commitment period of the subscription.

renew_automatically
boolean
required

Indicates if the subscription should automatically renew.

renew_for
object | null
required

If renew_automatically is enabled, will renew the subscription for the given interval.

activation_strategy
enum<string> | null
required

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.
Available options:
start_date,
manually,
checkout,
quote
starts_at
string
requireddeprecated

Deprecated field, please use contract_start.

contract_start
string
required

Subscription contract start date. UTC date time string in the ISO 8601 format.

contract_end
string
required

Subscription contract end date. UTC date time string in the ISO 8601 format.

initial_billing_at
string
required

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.

paused_at
string
required

Date when the subscription was paused. Only applies to paused status. UTC date time string in the ISO 8601 format.

reactivate_at
string
required

Date when the subscription will be automatically reactivated. UTC date time string in the ISO 8601 format.

cancel_at
string
required

Subscription cancel date. UTC date time string in the ISO 8601 format.

cancellation_strategy
enum<string> | null
required

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.
Available options:
refund_prorata,
refund_custom,
charge_prorata,
charge_custom,
end_of_period,
do_nothing
cancellation_amount
number
required

Custom amount used when cancelling the subscription. Only applies to the charge_custom or the refund_custom cancellation strategy.

estimated_arr
number
required

Estimated Annual Recurring Revenue generated by the subscription.

current_period_started_at
string
required

Start date of the current billing period. UTC date time string in the ISO 8601 format.

current_period_ends_at
string
required

End date of the current billing period. UTC date time string in the ISO 8601 format.

next_payment_at
string
required

Date on which the next subscription payment will occur. UTC date time string in the ISO 8601 format.

next_payment_amount
number
required

The amount of the next subscription payment. The system will generate an invoice to pay on the next_payment_at.

renews_at
string
required

Next subscription commitment renewal date. UTC date time string in the ISO 8601 format.

trial_ends_at
string
required

End date of the trial period. UTC date time string in the ISO 8601 format.

properties
object | null
required

Key/value pairs to store any information you find useful.

custom_properties
object | null
required

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.

created_at
string
required

Subscription creation date. UTC date time string in the ISO 8601 format.

updated_at
string
required

Subscription last edition date. UTC date time string in the ISO 8601 format.

products
object[]
required

Products that make up the subscription.

coupons
object[]
required

Coupons to be applied to the prices of subscription products.

plan
object | null
required
checkout_session
object | null
required

Checkout session of the subscription.

payment_method_type
enum<string> | null
required

Payment method type used to pay the subscription.

Available options:
card,
direct_debit,
direct_debit_ach,
direct_debit_bacs,
transfer,
transfer_automated,
external
payment_method
object | null
required

Payment method details used to pay the subscription.

generate_draft_invoices
boolean
required

Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent

Was this page helpful?

Create subscription updatesReinstate subscription