Billing Schedules

https://api.payload.com/billing_schedules

Nested Objects

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

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

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

Example

{
  "id": "bscd_Rb6nKJsKwiDtiZMgPslYalvc",
  "object": "billing_schedule",
  "amount_due": 31.67,
  "attrs": {},
  "charges": [],
  "created_at": "2024-08-21 13:35:03",
  "customer_id": "acct_os7Re9MDOXo3ns7fjpYDQr8l",
  "description": "string",
  "end_date": "2024-08-21",
  "invoices": [],
  "modified_at": "2024-08-21 13:35:03",
  "processing_id": "acct_19AOL3AvhQ5i9uHbF0ptowZJs",
  "recurring_amount": 767.3,
  "recurring_frequency": "daily",
  "start_date": "2024-08-21",
  "total_due": 676.75,
  "total_paid": 846.35,
  "type": "string",
  "annually": {
    "billing_day": 1,
    "billing_month": 1
  },
  "bimonthly": {
    "first_billing_day": 1,
    "second_billing_day": 1
  },
  "monthly": {
    "billing_day": null,
    "billing_week": null,
    "billing_weekday": null
  },
  "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
`amount_due` number readonly	Remaining amount due
`attrs` json	Custom object attributes
`charges` list	Array of associated Billing Charge objects
`created_at` datetime readonly	None
`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	None
`processing_id` id required	ID of associated Processing Account object
`recurring_amount` number readonly	Recurring amount due
`recurring_frequency` string	Values: daily weekly biweekly bimonthly monthly quarterly annually
`start_date` date	Start date of the billing schedule
`total_due` number readonly	Total amount due
`total_paid` number readonly	Total amount paid
`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	Values: None 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_week` string	Values: None first last
`billing_weekday` int	Values: None 0 1 2 3 4 5 6

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