Update subscription

post

https://www.pelcro.com/api/v1/sdk/subscription/{subscription_id}

This endpoint can be used to update an existing subscription owned by the customer.

This is a protected endpoint which requires proper authorization header to authenticate the customer.

Path Params

subscription_id

int32

required

The unique identifier of the subscription owned by the customer.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

suspend

boolean

a flag that indicates whether to suspend the subscription or unsuspend it

shipments_suspended_until

date

the date for the subscription suspension.

domains

array of strings

Email domains that will allow end-users with these domains to be members of this subscription upon registration/login. It can only be sent when the subscription plan type is membership.

domains

ip_addresses

array of strings

IP addresses that will identify end-users as members of this subscription upon registration/login. This attribute can only be set when the subscription plan type is membership. Two format are accepted for strings:

A single public IP address
This should be a valid public IP address following the standard IPv4 format (e.g., 192.168.1.100).

A range of public IP addresses
This should be a range of public IP addresses following the CIDR notation (e.g., 198.51.100.0/24).

You can use this tool calculate the appropriate CIDR notation for your needs.

ip_addresses

metadata

array of objects

Set of key-value pairs that can be saved on subscription level. This can be useful for storing additional information about the object in a structured format.

metadata

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

200200

400400