Skip to main content
GET
Retrieve billing

Authorizations

Authorization
string
header
required

API key prefixed with finta_

Response

The company's billing summary

object
enum<string>
required
Available options:
billing
plan
enum<string>
required
Available options:
formation,
startup,
growth,
enterprise
status
enum<string> | null
required

The card subscription's status. Null without one, as on Formation or Enterprise.

Available options:
incomplete,
incomplete_expired,
trialing,
active,
past_due,
canceled,
unpaid,
paused,
null
interval
enum<string>
required
Available options:
month,
year
renews_on
string<date> | null
required

When the plan next renews (UTC), or the trial ends. Null when it won't renew, including when a cancellation is scheduled.

plan_price_cents
integer | null
required

This company's price for the plan per interval, before any discount. Null when it isn't on file, as for a legacy subscriber billed outside the card subscription.

Required range: x >= 0
discount_cents
integer
required

The discount taken off each interval, as a negative amount. 0 without a discount. Counts a coupon only against the plans it covers; how long it lasts isn't returned.

Required range: x <= 0
total_cents
integer | null
required

What the company pays per interval while any discount lasts. Null when the price isn't on file.

Required range: x >= 0