Billing Schedules

Billing Schedules API Docs

Endpoint

https://api.payload.co/billing_schedules

Nested Objects

https://api.payload.co/billing_schedules/{id}/charges

https://api.payload.co/billing_schedules/{id}/customer

https://api.payload.co/billing_schedules/{id}/invoices

Example

{
  "id": "bscd_uWWtxrrRZzJfwkiO4ySzTdOr",
  "object": "billing_schedule",
  "attrs": {},
  "charges": [],
  "created_at": "2021-07-07 23:19:32",
  "customer_id": "acct_llacvjcNjJ9N3PhM5R7ywprH",
  "description": "string",
  "end_date": "2021-07-07",
  "invoices": [],
  "modified_at": "2021-07-07 23:19:32",
  "processing_id": "acct_29Fp4tTUU0d5N8ZqknWlLtiF",
  "recurring_frequency": "daily",
  "start_date": "2021-07-07",
  "type": "string",
  "annually": {
    "billing_day": 1,
    "billing_month": 1
  },
  "bimonthly": {
    "first_billing_day": 1,
    "second_billing_day": 1
  },
  "monthly": {
    "billing_day": 1
  },
  "quarterly": {
    "q1": {
      "billing_day": 1,
      "billing_month": 1
    },
    "q2": {
      "billing_day": 1,
      "billing_month": 4
    },
    "q3": {
      "billing_day": 1,
      "billing_month": 7
    },
    "q4": {
      "billing_day": 1,
      "billing_month": 10
    }
  }
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: billing_schedule
attrs
json
Custom object attributes
charges
list
Array of associated Billing Charge objects
created_at
datetime readonly
Timestamp object was created
customer_id
id required
ID of the associated Customer Account object
description
string
Billing Description
end_date
date
End date of the billing schedule
invoices
list
Array of associated Invoice objects
modified_at
datetime readonly
Timestamp object was last updated
processing_id
id required
ID of associated Processing Account object
recurring_frequency
string
Values: daily weekly biweekly bimonthly monthly quarterly annually
start_date
date
Start date of the billing schedule
type
string
Arbitrary type classification
annually:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12
 
bimonthly:  
first_billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
second_billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 
monthly:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 
quarterly:  
q1:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 1 2 3
 
q2:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 4 5 6
 
q3:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 7 8 9
 
q4:  
billing_day
int required
Values: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
billing_month
int required
Values: 10 11 12