v1

latestOpenAPI 3.1.02026-07-24571564.5 KB
Subscriptions

Update subscription's frequency

Update subscription's billing and delivery frequency.

post/customers/{customerId}/subscriptions/{subscriptionId}/frequency

Path parameters

customerIdstring required

Customer Id

subscriptionIdstring required

Subscription Id

Request body

intervalCountinteger required
interval'DAY' | 'WEEK' | 'MONTH' | 'YEAR' required

Response

Updated frequency properties

BillingIntervalBillingCountstring

[interval]#[intervalCount] e.g. MONTH#1

DeliveryIntervalDeliveryCountstring

[interval]#[intervalCount] e.g. MONTH#1

FormattedFrequencystring

e.g. Once a month