payment
subscription

Update a subscription

Changed on
put/payment/{connection_id}/subscription/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/payment/{connection_id}/subscription/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Subscription

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(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_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

current_period_start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

canceled_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

currencystring
total_amountnumber
start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status'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'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.

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(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_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

current_period_start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

canceled_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

currencystring
total_amountnumber
start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

status'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'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.

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 963bcc74f9e3Revision changes
    • info

      added the new optional request property

    • info

      added the enum value total_amount to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status