Retrieve a subscription
GET/payment/{connection_id}/subscription/{id}
Parameters
fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Subscription
Returns
idstring
created_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
descriptionstring
contact_idstring
a reference to an Accounting Contact (reference to AccountingContact)
invoice_idstring
a reference to an Accounting Invoice (reference to AccountingInvoice)
current_period_end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
current_period_start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
canceled_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
currencystring
start_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
status enum
Valid values:
"ACTIVE"
"INACTIVE"
"CANCELED"
"PAUSED"
monthnumber
the month on which to charge a customer (1-12). Only applies when the interval_unit is YEAR.
interval_unit enum
Valid values:
"YEAR"
"MONTH"
"WEEK"
"DAY"
day_of_monthnumber
The day of the month to charge customers on. 1-28 or -1 to indicate the last day of the month. Only applies when the interval_unit is MONTH.
day_of_weeknumber
The day of the week to charge customers on. 1-7 or -1 to indicate the last day of the week. Only applies when the interval_unit is WEEK.
intervalnumber
The number of intervals between charges within the interval_unit. Defaults to 1.
const options = {
method: 'GET',
url: 'https://api.unified.to/payment/5de520f96e439b002043d8dc/subscription/5de520f96e439b002043d8d8',
headers: {
authorization: 'bearer .....'
},
params: {
fields: '',
raw: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know