Subscriptions
Subscriptions represent the revenue that is occurring over time with payments of varying amounts and payment dates (installment subscription) or over fixed intervals of time with payments of the same amount (recurring subscription).
Get details of a subscription
Returns details of an installment or a recurring subscription.
Request
/v1/subscriptions/{id}
Path parameters
id
integer
required
The ID of the subscription
Response
OK
Expand all
Copy code- true
- { ... }▶
Find subscription by deal
Returns details of an installment or a recurring subscription by the deal ID.
Request
/v1/subscriptions/find/{dealId}
Path parameters
dealId
integer
required
The ID of the deal
Response
OK
Expand allCopy code- true
- { ... }▶
Get all payments of a subscription
Returns all payments of an installment or recurring subscription.
Request
/v1/subscriptions/{id}/payments
Path parameters
id
integer
required
The ID of the subscription
Response
OK
Expand allCopy code- true
- [ ... ]▶
Add a recurring subscription
Adds a new recurring subscription.
Request
/v1/subscriptions/recurring
Body parameters
application/json
deal_id
integer
required
The ID of the deal this recurring subscription is associated with
currency
string
required
The currency of the recurring subscription. Accepts a 3-character currency code.
description
string
The description of the recurring subscription
cadence_type
string
required
The interval between payments
Values
weekly
monthly
quarterly
yearly
cycles_count
integer
Shows how many payments the subscription has. Note that one field must be set: cycles_count or infinite. If cycles_count is set, then cycle_amount and start_date are also required.
cycle_amount
integer
required
The amount of each payment
start_date
string
required
The start date of the recurring subscription. Format: YYYY-MM-DD
Format
date
infinite
boolean
This indicates that the recurring subscription will last until it's manually canceled or deleted. Note that only one field must be set: cycles_count or infinite.
payments
array
Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_value
boolean
Indicates that the deal value must be set to recurring subscription's MRR value
Response
OK
Expand allCopy code- true
- { ... }▶
Add an installment subscription
Adds a new installment subscription.
Request
/v1/subscriptions/installment
Body parameters
application/json
deal_id
integer
required
The ID of the deal this installment subscription is associated with
currency
string
required
The currency of the installment subscription. Accepts a 3-character currency code.
payments
array
required
Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_value
boolean
Indicates that the deal value must be set to the installment subscription's total value
Response
OK
Expand allCopy code- true
- { ... }▶
Update a recurring subscription
Updates a recurring subscription.
Request
/v1/subscriptions/recurring/{id}
Path parameters
id
integer
required
The ID of the subscription
Body parameters
application/json
description
string
The description of the recurring subscription
cycle_amount
integer
The amount of each payment
payments
array
Array of additional payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with an explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_value
boolean
Indicates that the deal value must be set to recurring subscription's MRR value
effective_date
string
required
All payments after that date will be affected. Format: YYYY-MM-DD
Format
date
Response
OK
Expand allCopy code- true
- { ... }▶
Update an installment subscription
Updates an installment subscription.
Request
/v1/subscriptions/installment/{id}
Path parameters
id
integer
required
The ID of the subscription
Body parameters
application/json
payments
array
required
Array of payments. It requires a minimum structure as follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE }]. Replace SUM with a payment amount, DESCRIPTION with a explanation string, PAYMENT_DATE with a date (format YYYY-MM-DD).
update_deal_value
boolean
Indicates that the deal value must be set to installment subscription's total value
Response
OK
Expand allCopy code- true
- { ... }▶
Cancel a recurring subscription
Cancels a recurring subscription.
Request
/v1/subscriptions/recurring/{id}/cancel
Path parameters
id
integer
required
The ID of the subscription
Body parameters
application/json
end_date
string
The subscription termination date. All payments after the specified date will be deleted. The end_date of the subscription will be set to the due date of the payment to follow the specified date. Default value is the current date.
Format
date
Response
OK
Expand allCopy code- true
- { ... }▶
Delete a subscription
Marks an installment or a recurring subscription as deleted.
Request
/v1/subscriptions/{id}
Path parameters
id
integer
required
The ID of the subscription
Response
OK
Expand allCopy code- true
- { ... }▶