v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB

payment

subscription

Create a subscription

post/payment/{connection_id}/subscription

Path parameters

connection_idstring required

ID of the connection

Query parameters

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

Request body

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

Response

Successful