API & SDK Documentation

Subscriptions

Subscriptions are repeat billing agreements with specific buyers. BitPay sends bill emails to buyers identified in active subscriptions according to the specified schedule.

Resource

Name Type
facade
Facade used to view subscription objects, set to "merchant/subscription".
 string
data
Subscription data object
 object
id
Subscription resource Id
 string
status
Subscription object status. Can be draft, active or cancelled. Subscriptions in active state will create new Bills on the nextDelivery date.
 string
billData
Object containing the recurring billing information
 object
emailBill
If set the true, BitPay will automatically issue recurring bills to the email address provided once the status of the subscription is set to active.
 boolean
cc
Email addresses to which a copy of the recurring bill must be sent
 array
number
Recurring bill identifier, specified by merchant
 string
currency
ISO 4217 3-character currency code. This is the currency associated with the price field
 string
name
Recurring Bill recipient's name
 string
address1
Recurring Bill recipient's address
 string
address2
Recurring Bill recipient's address
 string
city
Recurring Bill recipient's city
 string
state
Recurring Bill recipient's state or province
 string
zip
Recurring Bill recipient's ZIP code
 string
country
Recurring Bill recipient's country
 string
email
Recurring Bill recipient's email address
 string
phone
Recurring Bill recipient's phone
 string
dueDate
Date and time at which a bill is due, ISO-8601 format yyyy-mm-ddThh:mm:ssZ (UTC).
 string
passProcessingFee
If set to true, BitPay's processing fee will be included in the amount charged on the invoice
 boolean
items
List of line items
 array
description
Line item description
 string
price
Line item unit price for the corresponding currency
 number
quantity
Line item number of units
 number
merchant
Internal identifier for BitPay, this field can be ignored by the merchants.
 string
schedule
Schedule of repeat bill due dates. Can be weekly, monthly, quarterly, yearly, or a simple cron expression specifying seconds, minutes, hours, day of month, month, and day of week. BitPay maintains the difference between the due date and the delivery date in all subsequent, automatically-generated bills.

+-------------- second (0 - 59)

| +------------ minute (0 - 59)

| | +---------- hour (0 - 23)

| | | +-------- day of month (1 - 31)

| | | | +------ month (1 - 12)

| | | | | +---- day of week (0 - 6) (Sunday=0 or 7)

| | | | | |

* * * * * * Cron expression
string
nextDelivery
Default is current date & time, ISO-8601 format yyyy-mm-ddThh:mm:ssZ (UTC). Current or past date indicates that the bill can be delivered immediately. BitPay may modify the hh:mm:ss values in order to distribute deliveries evenly throughout the day.
 string
createdDate
Date and time of recurring billing creation, ISO-8601 format yyyy-mm-ddThh:mm:ssZ (UTC)
 string
token
API token for subscription resource. This token is actually derived from the API token used to create the subscription and is tied to the specific resource id created.
string