Skip to main content
PATCH
/
v1
/
subscriptions
/
{id}
Update subscription
curl --request PATCH \
  --url https://api-global.fastpaybrasil.com/v1/subscriptions/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingDay": 15,
  "metadata": {
    "notes": "VIP customer"
  }
}
'
{
  "success": true,
  "id": "2RhQg9M7ZCg3X3nMb9W1kX8Q",
  "billingDay": 15,
  "metadata": {
    "notes": "VIP customer"
  }
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication. Use your secret key as the username and an empty string as password. The API key should be base64 encoded in the format 'username:' when sending the Authorization header.

Path Parameters

​
id
string
required

Unique subscription identifier

Body

application/json
​
billingDay
integer

Day of month for billing (1-28)

Required range: 1 <= x <= 28
Example:

15

​
metadata
object

Additional metadata for the subscription

Example:
{ "notes": "VIP customer" }

Response

Subscription successfully updated

​
success
boolean

Update success status

Example:

true

​
id
string

Subscription ID

Example:

"2RhQg9M7ZCg3X3nMb9W1kX8Q"

​
billingDay
integer

Updated billing day

Example:

15

​
metadata
object

Updated metadata

Example:
{ "notes": "VIP customer" }