/billing/overview

GET

/billing/overview

curl --request GET \
  --url https://api.chatfood.app/billing/overview \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer
• ApiKey

Parameters

Query Parameters

accountId

string format: uuid

Responses

200

OK

object

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

plan

object

id

string format: uuid

name

string

nullable

currency

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

pricingMode

string

Allowed values: PerUnit Graduated Flat

unitPrice

number format: double

tiers

Array<object>

nullable

object

upTo

integer format: int64

nullable

unitPrice

number format: double

flatAmountCents

integer format: int64

minimumCents

integer format: int64

includedUnits

integer format: int64

pixDiscountBps

integer format: int32

dueDays

integer format: int32

estimate

object

customerId

string format: uuid

customerName

string

nullable

planId

string format: uuid

planName

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

periodStart

string format: date

periodEnd

string format: date

measuredThrough

string format: date

totalQuantity

number format: double

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

totalCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

fixedTotal

boolean

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

baseUnitPrice

number format: double

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

overrideScope

string

Allowed values: Company Account Page

baseAmountCents

integer format: int64

amountCents

integer format: int64

unmeasured

boolean

recentInvoices

Array<object>

nullable

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

object

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

plan

object

id

string format: uuid

name

string

nullable

currency

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

pricingMode

string

Allowed values: PerUnit Graduated Flat

unitPrice

number format: double

tiers

Array<object>

nullable

object

upTo

integer format: int64

nullable

unitPrice

number format: double

flatAmountCents

integer format: int64

minimumCents

integer format: int64

includedUnits

integer format: int64

pixDiscountBps

integer format: int32

dueDays

integer format: int32

estimate

object

customerId

string format: uuid

customerName

string

nullable

planId

string format: uuid

planName

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

periodStart

string format: date

periodEnd

string format: date

measuredThrough

string format: date

totalQuantity

number format: double

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

totalCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

fixedTotal

boolean

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

baseUnitPrice

number format: double

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

overrideScope

string

Allowed values: Company Account Page

baseAmountCents

integer format: int64

amountCents

integer format: int64

unmeasured

boolean

recentInvoices

Array<object>

nullable

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

Example

{
  "customer": {
    "status": "Trial",
    "preferredMethod": "Ask"
  },
  "plan": {
    "basis": "ActiveLeadsEndOfPeriod",
    "pricingMode": "PerUnit"
  },
  "estimate": {
    "basis": "ActiveLeadsEndOfPeriod",
    "lines": [
      {
        "overrideKind": "PercentDiscount",
        "overrideScope": "Company"
      }
    ]
  },
  "recentInvoices": [
    {
      "status": "Open",
      "basis": "ActiveLeadsEndOfPeriod"
    }
  ]
}

object

customer

object

id

string format: uuid

companyId

string format: uuid

nullable

accountId

string format: uuid

nullable

planId

string format: uuid

planName

string

nullable

ownerName

string

nullable

isCompany

boolean

status

string

Allowed values: Trial Active PastDue Suspended Cancelled

trialEndsAt

string format: date-time

nullable

billingEmail

string

nullable

legalName

string

nullable

taxId

string

nullable

preferredMethod

string

Allowed values: Ask Card Pix

pixDiscountBps

integer format: int32

nullable

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

plan

object

id

string format: uuid

name

string

nullable

currency

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

pricingMode

string

Allowed values: PerUnit Graduated Flat

unitPrice

number format: double

tiers

Array<object>

nullable

object

upTo

integer format: int64

nullable

unitPrice

number format: double

flatAmountCents

integer format: int64

minimumCents

integer format: int64

includedUnits

integer format: int64

pixDiscountBps

integer format: int32

dueDays

integer format: int32

estimate

object

customerId

string format: uuid

customerName

string

nullable

planId

string format: uuid

planName

string

nullable

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

periodStart

string format: date

periodEnd

string format: date

measuredThrough

string format: date

totalQuantity

number format: double

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

totalCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

fixedTotal

boolean

lines

Array<object>

nullable

object

pageId

string format: uuid

pageName

string

nullable

accountId

string format: uuid

nullable

accountName

string

nullable

quantity

number format: double

billableQuantity

number format: double

baseUnitPrice

number format: double

unitPrice

number format: double

overrideKind

string

Allowed values: PercentDiscount FixedUnitPrice FixedTotal Free

overrideScope

string

Allowed values: Company Account Page

baseAmountCents

integer format: int64

amountCents

integer format: int64

unmeasured

boolean

recentInvoices

Array<object>

nullable

object

id

string format: uuid

number

string

nullable

status

string

Allowed values: Open Paid PastDue Void Waived

periodStart

string format: date

periodEnd

string format: date

basis

string

Allowed values: ActiveLeadsEndOfPeriod ActiveLeadsPeak UniqueLeadsReached NewLeads

issuedAt

string format: date-time

dueAt

string format: date-time

subtotalCents

integer format: int64

discountCents

integer format: int64

adjustmentCents

integer format: int64

amountCents

integer format: int64

pixDiscountBps

integer format: int32

amountPixCents

integer format: int64

trial

boolean

paidAt

string format: date-time

nullable

Example

{
  "customer": {
    "status": "Trial",
    "preferredMethod": "Ask"
  },
  "plan": {
    "basis": "ActiveLeadsEndOfPeriod",
    "pricingMode": "PerUnit"
  },
  "estimate": {
    "basis": "ActiveLeadsEndOfPeriod",
    "lines": [
      {
        "overrideKind": "PercentDiscount",
        "overrideScope": "Company"
      }
    ]
  },
  "recentInvoices": [
    {
      "status": "Open",
      "basis": "ActiveLeadsEndOfPeriod"
    }
  ]
}