Skip to main content
PUT
Replace Subscription Primary Payment Method

Authorizations

x-revolv3-token
string
header
required

Headers

Client-Request-Id
string

Optional identifier generated by the client to match its own logs with this request.

Allowed values: 1 to 128 characters, letters, digits and ., _, :, -.

Examples: order-12345, 3f2b8c1e-9d4a-4e7b-a1c5-6b0d2e8f7a91 (GUID), checkout:2026-11-02.17, retry_1.order-12345.

A valid value is returned in the Client-Request-Id response header and is stored with Revolv3 request logs, so it can be used when contacting support. An invalid value is ignored and the request is processed normally. Do not send sensitive data in this header.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]{1,128}$

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