Change a subscription's card

Replaces the card the subscription's card-collected components are charged to with another of the Account's own cards. The person on the session authorizes charging the new card, so API keys, service accounts and impersonated sessions receive 403. The change applies to every charge sent after it, including the next retry of a period already in dunning; a charge already sent stays on the card it was sent to. Merge-patch with updateMask: [parties]; the components the card pays for and the collection method cannot change here, and instrumentAuthorization is written by the server only. If-Match is required and * does not satisfy it. A card the Account does not hold returns 404; a card payments cannot charge returns 422 with detailCode revenue.FundingInstrumentNotSupported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 128
Body Params
updateMask
array of strings, unique
required
length ≥ 1

The fields this request changes. Only parties is accepted.

parties
array of objects
required
length between 1 and 1
parties*
string
enum
required
Allowed:
string | array

Optional; when sent it must match the current value.

string
enum

Optional; when sent it must match the current value.

Allowed:
instrument
object
required
Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
required

Strong ETag from the latest resource GET or write response.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json