V3SubscriptionTransactionSubscriptionPaymentRequest

V3SubscriptionTransactionSubscriptionPaymentRequest
V3SubscriptionTransactionSubscriptionPaymentRequest

Applicable to SUBSCRIPTION_PAYMENT operation, for example change payment method for a given subscription

JSON Example
{
    "idempotencyKey": "46ed2864-0f5e-4e46-a70a-6b3beb1891d2",
    "paymentMethodId": "db36fc9b-6fde-4f10-8f32-2b2524a574fc",
    "removeOverride": false,
    "subscriptionId": "730eec0c-6f9f-40df-95c1-c4f1bfe3f1bd"
}
string As uuid As uuid
idempotencyKey
Required

A unique key provided per request. On retry please submit same key again to prevent duplicates. Duplicate submission is not treated as error, instead current state is returned as applicable for the operation

string
paymentMethodId
Optional

CSP Payment Method Id to over-ride with. Required if removeOverride is not true

boolean
removeOverride
Optional

If true then any existing over-ride is removed

string
subscriptionId
Required

CSP subscription Id.