v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
payment
subscription

List all subscriptions

get/payment/{connection_id}/subscription

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

contact_idstring

The contact ID to filter by (reference to AccountingContact)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
descriptionstring
contact_idstring
invoice_idstring
current_period_end_atstring date-time
current_period_start_atstring date-time
canceled_atstring date-time
currencystring
total_amountnumber
start_atstring date-time
end_atstring date-time
status'ACTIVE' | 'INACTIVE' | 'CANCELED' | 'PAUSED'
monthnumber
interval_unit'YEAR' | 'MONTH' | 'WEEK' | 'DAY'
day_of_monthnumber
day_of_weeknumber
intervalnumber
rawobject