Renew subscription

post

https://www.pelcro.com/api/v1/sdk/subscription/renew

Renew a subscription for a customer on-session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

plan_id

int32

required

The unique identifier of plan the subscription should renew on. If you associated a customer segment to the plan, a validation will be performed. Therefore, it is recommended to validate against eligible plans for the customer first. Always required.

subscription_id

int32

required

The unique identifier of the subscription to renew. Always required.

language

string

The customer’s preferred language as a two-letter code, defined by ISO 639-1 standard. Always required.

payment_gateway

string

enum

Defaults to stripe

The optional payment gateway, one of stripe, braintree, vantiv, tap or cybersource. Always defaults to stripe.

Allowed:

gateway_token

string

The single-use token that represents the payment method details. Typically generated using the payment gateway's tools and libraries. This payment method will be used to attempt payments for the subscription.

address_id

int32

The identifier of the shipping address to associate with the subscription. Required if related product requires an address, if product is available only in certain countries, or if tax feature is enabled under your account.

source_id

int32

The unique identifier of chargeable payment method already attached to the customer, which will be used to attempt payments for this subscription.

campaign_key

string

The campaign associated to the subscription. If the key does not already exist, it will be created. The campaign key must be between 3 and 191 characters in length and include only letters, numbers, dashes and underscores without space.

coupon_code

string

An optional coupon code to apply a discount to the subscription renewal. If you associated a customer segment to the coupon, a validation will be performed. Therefore, it is recommended to validate against eligible coupons for the customer first.

quantity

int32

Defaults to 1

Quantity for this subscription, always 1 by default.

source

string

An arbitrary string specifying the origin of the subscription request. (ex: web, bobile, blow-in/letter, phone, API, imported, etc.)

replace_upcoming_phases

boolean

Defaults to false

A boolean flag that, when true, deletes all scheduled future phases before adding a new renewal phase. Used primarily for save offer flows during cancellation to replace existing renewals with a single discounted phase.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

200200

400400