Update a Subscription

put

https://test.bitpay.com/subscriptions/{subscriptionId}

Facades: merchant

Path Params

subscription

string

required

The ID of the subscription you want to update.

Body Params

status

string

Can be draft or active or cancelled. Subscriptions in active state will create new Bills on the nextDelivery date.

billData

object

Object containing the recurring billing information

Headers

Content-Type

string

required

Defaults to application/json

Must be set to application/json for requests to the BitPay API

X-Accept-Version

string

required

Defaults to 2.0.0

Must be set to 2.0.0 for requests to the BitPay API

X-Identity

string

required

The hexadecimal public key generated from the client private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

X-Signature

string

required

The ECDSA signature of the full request URL concatenated with the request body, signed with your private key. This header is optional for this endpoint when using the public facade, and required when using a merchant facade token.

Response

Language

Loading…

Response

Choose an example:

application/json

200200