Skip to main content
PUT
/
api
/
Subscriptions
/
{subscriptionId}
/
payment-method
Error
A valid request URL is required to generate request examples
{
  "subscriptionId": 1,
  "customerId": 1,
  "merchantSubscriptionRefId": "1234-5678-9101",
  "networkTransactionId": null,
  "billingIntervalType": "Months",
  "billingIntervalCount": 1,
  "subscriptionStatusType": "Current",
  "subscriptionCancelType": "Immediate",
  "initialBillDate": "22-Jun-26",
  "nextBillDate": "22-Jul-26",
  "taxAddress": null,
  "paymentMethodIds": [
    1,
    2
  ],
  "cancelledAt": null,
  "billingPlans": [
    {
      "subscriptionBillingPlanId": 1,
      "subscriptionId": 0,
      "name": "Billing Plan 1",
      "value": 10.99,
      "startDate": "22-Jun-26",
      "cyclesRemaining": -1,
      "cycleCount": 0,
      "valueType": "Standard"
    },
    {
      "subscriptionBillingPlanId": 2,
      "subscriptionId": 0,
      "name": "Billing Plan 2",
      "value": 14.99,
      "startDate": "22-Jul-26",
      "cyclesRemaining": 12,
      "cycleCount": 0,
      "valueType": "Standard"
    }
  ],
  "message": null,
  "paymentProcessor": null,
  "processorMerchantId": null,
  "processorRawResponse": null,
  "currency": null,
  "responseMessage": null,
  "responseCode": null
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscriptionId
integer<int64>
required
Required range: 1 <= x <= 1000000000

Body

existingPaymentMethod
object
paymentMethod
object

Response

OK

subscriptionId
integer<int64>
Required range: 1 <= x <= 1000000000
customerId
integer<int64>
Required range: 1 <= x <= 1000000000
merchantSubscriptionRefId
string | null
Maximum string length: 100
networkTransactionId
string | null
Maximum string length: 100
billingIntervalType
string | null
Maximum string length: 50
billingIntervalCount
integer<int32>
Required range: 1 <= x <= 1000000000
subscriptionStatusType
string | null
Maximum string length: 50
subscriptionCancelType
string | null
Maximum string length: 50
initialBillDate
string | null
Maximum string length: 20
nextBillDate
string | null
Maximum string length: 20
taxAddress
object
paymentMethodIds
integer<int64>[] | null
cancelledAt
string<date-time> | null
Maximum string length: 40
billingPlans
object[] | null
message
string | null
Maximum string length: 500
paymentProcessor
string | null
Maximum string length: 100
processorMerchantId
string | null
Maximum string length: 100
processorRawResponse
string | null
Maximum string length: 10000
currency
string | null
Maximum string length: 3
responseMessage
string | null
Maximum string length: 500
responseCode
string | null
Maximum string length: 10