Sign in
Contracts

Create a contract.

Contracts are subscription objects in LedgerUp Engine.

post/v2/contracts

Request body

account_idstring required

LedgerUp resource identifier.

customer_idstring uuid required
stripe_customer_idstring nullable
currency_codestring required
billing_interval'month' | 'quarter' | 'year' | 'one_time' | 'contract_term' required

How often the line is evaluated for billing.

starts_atinteger required

Unix timestamp in seconds.

ends_atinteger

Unix timestamp in seconds.

payment_termsstring nullable
{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}

Example request

{
  "currency_code": "USD",
  "billing_interval": "month",
  "starts_at": 1767225600,
  "ends_at": 1767225600,
  "payment_terms": "net_30"
}

Response

Success.

idstring required

LedgerUp resource identifier.

account_idstring required

LedgerUp resource identifier.

customer_idstring uuid required
stripe_customer_idstring nullable required
status'draft' | 'active' | 'canceled' | 'expired' required
currency_codestring required
billing_interval'month' | 'quarter' | 'year' | 'one_time' | 'contract_term' required

How often the line is evaluated for billing.

starts_atinteger required

Unix timestamp in seconds.

ends_atinteger required

Unix timestamp in seconds.

payment_termsstring nullable required
{"stackTrail":"components:schemas:Properties","oasType":"schema","type":"unknown","description":"Arbitrary JSON object or value. If omitted on write endpoints, the service stores an empty object."}
created_atinteger required

Unix timestamp in seconds.

updated_atinteger required

Unix timestamp in seconds.

canceled_atinteger required

Unix timestamp in seconds.

cancel_atinteger required

Unix timestamp in seconds.

Example response

{
  "status": "active",
  "billing_interval": "month",
  "starts_at": 1767225600,
  "ends_at": 1767225600,
  "created_at": 1767225600,
  "updated_at": 1767225600,
  "canceled_at": 1767225600,
  "cancel_at": 1767225600
}

Changes