Skip to main content
  • Subscription Commitment
  • One-Time Commitment

Represents a purchase commitment. Can be one of two types: Subscription or OneTime.

A "subscription" typed commitment represents a purchase commitment that will be paid in installments over a given period, whereas a "one-time" commitment will be paid in full once.

type
string

Type of the commitment.

Allowed value: "SubscriptionCommitment"
owner
Reference to a user · object

Owner of the commitment.

purchase
Reference to a purchase · object

Purchase of the commitment.

attachments
attachment · object[]

Attachments of the commitment.

Required array length: 1 - 3 elements
comment
string | null

Comment of the commitment.

paymentMethod
enum<string> | null

Method of payment of the commitment.

Available options:
BankTransfer,
PhysicalCard,
Check,
DirectDebit,
SingleUseCard
state
enum<string>

State of the commitment.

Available options:
Created,
UnderReview,
Provisioned,
Denied,
Cancelled
startDate
string<date>

Start date of the subscription.

firstInvoiceDate
string<date>

Date of the first invoice.

invoicingFrequency
object

Invoicing frequency of the subscription.

subscriptionDuration
object

Duration of the subscription.

contractualObligation
object

Contractual obligation of the subscription.

terminationNotice
object

Termination notice of the subscription.

amountIncludingTaxesPerPeriod
Dual currency taxed amount · object

Amount including taxes per period.

amountIncludingTaxes
Dual currency taxed amount · object

Amount including taxes.

subscriptionEndDate
string<date>

End date of the subscription.

periodsCount
integer<int32>

Number of periods.

contractualEndDate
string<date> | null

End date of the contractual obligation.

author
Reference to a user · object

Read-only. User ID who is the author of the commitment.

modifier
Reference to a user · object

Read-only. User ID who is the modifier of the commitment.