Skip to main content
Create a new subscription for recurring billing. Subscriptions automatically generate invoices at regular intervals.

Request Body

FieldTypeRequiredDescription
contact_idstringYesReference to the Contact
currency_idstringYesISO 4217 currency code
amountnumberYesRecurring charge amount per billing cycle
intervalstringYesBilling frequency: day, week, month, year
interval_countintegerNoIntervals between billings (default: 1)
statusstringNoInitial status: active, in_trial (default: active)
itemsarrayNoProducts/services in the subscription

Subscription Item Fields

FieldTypeRequiredDescription
item_idstringNoReference to an Item/Product
descriptionstringYesDescription of the subscribed service
quantityintegerYesNumber of units
unit_amountnumberYesPrice per unit
See Subscription Overview for complete field details.