Update a Subscription

patch

https://api-dev.gettrx.com/payments/v1/subscriptions/{subscriptionId}

Path Params

subscriptionId

string

required

Body Params

billingCycleAnchorDate

number | null

defaultPaymentMethod

string

collectionMethod

string

daysUntilDue

integer | null

paymentBehavior

string

cancelAtPeriodEnd

boolean

cancelOn

integer | null

trialEnd

integer | null

trialEndDays

integer

pauseCollection

object

accountFees

array of strings

accountFees

accountDiscounts

array of strings

accountDiscounts

accountFeeAndDiscountDisplayLayout

string

recurringItems

array of objects

recurringItems

oneTimeItems

array of objects

oneTimeItems

oneTimeItemsBillingBehavior

string

paymentMethodTypes

array of strings

paymentMethodTypes

Headers

secretKey

string

required

Secret key associated to the partner’s account

idempotencyKey

string

Unique key generated by the partner

onBehalfOf

string

AccountId of the merchant that will own the fee

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200