Update subscription

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Update a subscription owned by the authenticated customer: pause or resume shipments (suspend + shipments_suspended_until), and set domains, ip_addresses, or merge metadata. Returns the customer resource with a fresh JWT.

Example:

curl --request PUT \
  --url 'https://www.pelcro.com/api/v1/sdk/subscription/4055?site_id=1232' \
  --header 'Authorization: Bearer <JWT>' \
  --header 'Content-Type: application/json' \
  --data '{ "suspend": true, "shipments_suspended_until": "2026-08-01" }'

Notes

  • Protected — requires the customer's JWT.
  • An unknown/unowned subscription returns 404; validation failures (e.g. suspend without shipments_suspended_until) are 400.
Path Params
string
required
Query Params
int32
required
Body Params
boolean
date
domains
array of strings
domains
ip_addresses
array of strings
ip_addresses
metadata
array of objects
metadata
Headers
string
required
Defaults to Bearer <token>
Responses

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