Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.subscription_started
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Financial dataThe plan changed, an add-on was bought, or a cancellation was undone. previous_attributes holds what changed.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.subscription_changed
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Financial dataA cancellation was scheduled. cancel_at is when access ends.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.subscription_canceled
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Financial dataA trial or pilot began. No card is needed.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.trial_started
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Financial dataA trial or pilot has 7, 3 or 1 days left. Sent once for each of those marks. trial.days_left says which.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.trial_ending
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Financial dataA trial or pilot ended without a paid plan. The church keeps its content and moves to read-only.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is subscription.
Fields of data.object for billing.trial_ended
Field
Type
Description
cancel_at required
string (date-time) | null
When access ends after a scheduled cancellation.
canceled_at required
string (date-time) | null
When it was canceled.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it started.
currency required
string
The billing currency.
current_period required
object
The period being billed.
end required
string (date-time)
When it ends.
start required
string (date-time)
When the period began.
id required
string
The subscription id.
interval required
enum: month | year
month or year.
items required
object
The plan and any add-ons.
data required
object[]
description required
string
What is billed.
object required
enum: subscription_item
Always subscription_item.
price required
object
The recurring price.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
quantity required
integer
How many.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is invoice.
Fields of data.object for billing.invoice_paid
Field
Type
Description
amount_due_minor required
integer
What is still owed.
amount_paid_minor required
integer
What has been paid.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it was created.
currency required
string
The ISO 4217 currency code in upper case.
id required
string
The invoice id.
issued_at required
string (date-time) | null
When it was issued.
last_payment_error required
object | null
Why the latest charge failed.
attempted_at required
string (date-time)
When the charge was tried.
code required
string
A short code such as card_declined.
message required
string
A plain message safe to show.
lines required
object
What was charged.
data required
object[]
amount_minor required
integer
The line amount before tax in the smallest currency unit.
description required
string
What was charged.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
number required
string
The invoice number.
object required
enum: invoice
Always invoice.
payment_method required
object | null
The method that paid or was tried. Only a brand and last four digits.
brand required
string | null
The card brand, null when none is on file.
exp_month required
integer | null
The expiry month, null when unknown.
exp_year required
integer | null
The expiry year, null when unknown.
id required
string
The payment method id.
kind required
string
card, bank or wallet.
last4 required
string | null
The last four digits, never the full number; null when none.
object required
enum: payment_method
Always payment_method.
period_end required
string (date-time) | null
When the billed period ends.
period_start required
string (date-time) | null
When the billed period starts.
provider required
string
The payment provider key.
provider_url required
string
A hosted invoice page, empty when none.
refunds required
object
Refunds issued against it.
data required
object[]
amount_minor required
integer
The refunded amount.
created_at required
string (date-time)
When it was issued.
id required
string
The refund id.
object required
enum: refund
Always refund.
status required
string
The refund status.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
status required
enum: draft | open | paid | void | uncollectible
The invoice status.
status_transitions required
object
When the invoice reached each state.
due_at required
string (date-time) | null
When payment is due.
paid_at required
string (date-time) | null
When it was paid.
subscription required
object | null
The subscription it bills.
id required
string
The subscription id.
object required
enum: subscription
Always subscription.
status required
string
The subscription status.
subtotal_minor required
integer
The total before tax in the smallest currency unit.
tax_label required
string
How the tax is described on the invoice.
tax_lines required
object
The taxes charged.
data required
object[]
amount_minor required
integer
The tax amount in the smallest currency unit.
inclusive required
boolean
True when the price already included the tax.
jurisdiction required
string
The tax jurisdiction, empty when not recorded.
label required
string
What the tax is called on the invoice.
rate_bps required
integer
The rate in basis points, 2000 is 20 percent; 0 for reverse charge or zero-rated.
tax_type required
string
The kind of tax: vat, gst, sales_tax and so on, empty when the provider calculated it.
treatment required
string
charge, reverse_charge, zero_rated or none.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
tax_minor required
integer
The tax in the smallest currency unit.
tax_notes required
string[]
Legal notes printed with the tax, such as a reverse-charge statement.
total required
object
The invoice total as an amount with its currency.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
currency required
string
The ISO 4217 currency code in upper case.
total_minor required
integer
The total in the smallest currency unit.
On updates, data.previous_attributes holds the earlier value of any of these that changed: status, amount_paid_minor, amount_due_minor.
Financial dataA charge did not go through. Nothing is paused yet. last_payment_error says why.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is invoice.
Fields of data.object for billing.payment_failed
Field
Type
Description
amount_due_minor required
integer
What is still owed.
amount_paid_minor required
integer
What has been paid.
church required
object
The church it belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
created_at required
string (date-time)
When it was created.
currency required
string
The ISO 4217 currency code in upper case.
id required
string
The invoice id.
issued_at required
string (date-time) | null
When it was issued.
last_payment_error required
object | null
Why the latest charge failed.
attempted_at required
string (date-time)
When the charge was tried.
code required
string
A short code such as card_declined.
message required
string
A plain message safe to show.
lines required
object
What was charged.
data required
object[]
amount_minor required
integer
The line amount before tax in the smallest currency unit.
description required
string
What was charged.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
number required
string
The invoice number.
object required
enum: invoice
Always invoice.
payment_method required
object | null
The method that paid or was tried. Only a brand and last four digits.
brand required
string | null
The card brand, null when none is on file.
exp_month required
integer | null
The expiry month, null when unknown.
exp_year required
integer | null
The expiry year, null when unknown.
id required
string
The payment method id.
kind required
string
card, bank or wallet.
last4 required
string | null
The last four digits, never the full number; null when none.
object required
enum: payment_method
Always payment_method.
period_end required
string (date-time) | null
When the billed period ends.
period_start required
string (date-time) | null
When the billed period starts.
provider required
string
The payment provider key.
provider_url required
string
A hosted invoice page, empty when none.
refunds required
object
Refunds issued against it.
data required
object[]
amount_minor required
integer
The refunded amount.
created_at required
string (date-time)
When it was issued.
id required
string
The refund id.
object required
enum: refund
Always refund.
status required
string
The refund status.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
status required
enum: draft | open | paid | void | uncollectible
The invoice status.
status_transitions required
object
When the invoice reached each state.
due_at required
string (date-time) | null
When payment is due.
paid_at required
string (date-time) | null
When it was paid.
subscription required
object | null
The subscription it bills.
id required
string
The subscription id.
object required
enum: subscription
Always subscription.
status required
string
The subscription status.
subtotal_minor required
integer
The total before tax in the smallest currency unit.
tax_label required
string
How the tax is described on the invoice.
tax_lines required
object
The taxes charged.
data required
object[]
amount_minor required
integer
The tax amount in the smallest currency unit.
inclusive required
boolean
True when the price already included the tax.
jurisdiction required
string
The tax jurisdiction, empty when not recorded.
label required
string
What the tax is called on the invoice.
rate_bps required
integer
The rate in basis points, 2000 is 20 percent; 0 for reverse charge or zero-rated.
tax_type required
string
The kind of tax: vat, gst, sales_tax and so on, empty when the provider calculated it.
treatment required
string
charge, reverse_charge, zero_rated or none.
has_more required
boolean
True when more items exist than this page holds; fetch them from url.
object required
value
url required
string
The API path that lists every item.
tax_minor required
integer
The tax in the smallest currency unit.
tax_notes required
string[]
Legal notes printed with the tax, such as a reverse-charge statement.
total required
object
The invoice total as an amount with its currency.
amount_minor required
integer
The amount in the smallest currency unit, 7900 is 79.00.
Financial dataUsage for a meter reached what the plan includes this period. Sent once per meter per period.
Billing facts in minor units with the currency. Card numbers, bank details and provider tokens are never included, only a brand and the last four digits.
data.object.object is usage_meter.
Fields of data.object for billing.quota_reached
Field
Type
Description
church required
object
The church the usage belongs to.
id required
string
The church id.
name required
string
The church name.
object required
enum: church
Always church.
slug required
string
The church web address.
consumed required
integer
What has been used this period.
id required
string
The meter key.
included required
integer
What the plan includes, with credits.
meter required
string
The meter key: hours, generations, ask_messages and so on.