Gift subscription

post

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

This endpoint can be used to create a gift subscription.

This is a protected endpoint which requires proper authorization header to authenticate the customerand returns a Customer resource.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

plan_id

string

required

The unique identifier of plan. 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.

gift_recipient_email

string

required

The gift recipient email address. Always required.

gift_recipient_first_name

string

required

The gift recipient first name. Always required.

gift_recipient_last_name

string

required

The gift recipient last name. Always required.

gift_recipient_full_name

string

required

The gift recipient full name. 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.

coupon_code

string

An optional coupon code to apply a discount to the subscription. 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.

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.

quantity

int32

Defaults to 1

Quantity for this subscription, always 1 by default.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

200200

400400