Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 4.5 KB

create-subscription-request.md

File metadata and controls

48 lines (39 loc) · 4.5 KB

Create Subscription Request

Defines input parameters in a request to the CreateSubscription endpoint.

Structure

CreateSubscriptionRequest

Fields

Name Type Tags Description
idempotencyKey string | undefined Optional A unique string that identifies this CreateSubscription request.
If you do not provide a unique string (or provide an empty string as the value),
the endpoint treats each request as independent.

For more information, see Idempotency keys.
locationId string Required The ID of the location the subscription is associated with.
Constraints: Minimum Length: 1
planId string Required The ID of the subscription plan created using the Catalog API.
For more information, see
Set Up and Manage a Subscription Plan and
Subscriptions Walkthrough.
Constraints: Minimum Length: 1
customerId string Required The ID of the customer subscribing to the subscription plan.
Constraints: Minimum Length: 1
startDate string | undefined Optional The YYYY-MM-DD-formatted date to start the subscription.
If it is unspecified, the subscription starts immediately.
canceledDate string | undefined Optional The YYYY-MM-DD-formatted date when the newly created subscription is scheduled for cancellation.

This date overrides the cancellation date set in the plan configuration.
If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops
at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle.

When the subscription plan of the newly created subscription has a fixed number of cycles and the canceled_date
occurs before the subscription plan expires, the specified canceled_date sets the date when the subscription
stops through the end of the last cycle.
taxPercentage string | undefined Optional The tax to add when billing the subscription.
The percentage is expressed in decimal form, using a '.' as the decimal
separator and without a '%' sign. For example, a value of 7.5
corresponds to 7.5%.
Constraints: Maximum Length: 10
priceOverrideMoney Money | undefined Optional Represents an amount of money. Money fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
Working with Monetary Amounts
for more information.
cardId string | undefined Optional The ID of the subscriber's card to charge.
If it is not specified, the subscriber receives an invoice via email. For an example to
create a customer profile for a subscriber and add a card on file, see Subscriptions Walkthrough.
timezone string | undefined Optional The timezone that is used in date calculations for the subscription. If unset, defaults to
the location timezone. If a timezone is not configured for the location, defaults to "America/New_York".
Format: the IANA Timezone Database identifier for the location timezone. For
a list of time zones, see List of tz database time zones.
source SubscriptionSource | undefined Optional The origination details of the subscription.

Example (as JSON)

{
  "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
  "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
  "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf",
  "location_id": "S8GWD5R9QB376",
  "plan_id": "6JHXF3B2CW3YKHDV4XEM674H",
  "price_override_money": {
    "amount": 100,
    "currency": "USD"
  },
  "source": {
    "name": "My App"
  },
  "start_date": "2021-10-20",
  "tax_percentage": "5",
  "timezone": "America/Los_Angeles"
}