Common Models

The following is an overview of the Commitment object and its related objects. In some cases, the related object has a dedicated endpoint. In these cases, a link to those endpoints is provided.

Commitment

Property

Type

Description

commitmentId

int

Read-only; Unique identifier for a Recurring Commitment in this context

startDate

datetime

Read-only; Date the Recurring Commitment started

endDate

datetime

Read-only; Date the Recurring Commitment ended

status

string

The commitment status of the current Recurring Commitment

amount

decimal

Monetary amount of each Recurring Commitment

currency

int

Read-only; The currency that is being used for the Recurring Commitment

frequency

string

Read-only; The Frequency of each recurring commitment

nextTransactionDate

datetime

Date on which the next Recurring Commitment will be processed

paymentType

string

Read-only; PaymentType in which the funds will be contributed

creditCardLast4

int

Read-only; Last 4 digits of the credit card used for the commitment

ccExpirationYear

int

Read-only; Year that the credit card expires

ccExpirationMonth

int

Read-only; Month that the credit card expires

designationId

int

Read-only; The id of the designation which receives this contribution.

Frequency

One of

  • Weekly
  • EveryTwoWeeks
  • EveryFourWeeks
  • Monthly
  • TwiceMonthly
  • Quarterly
  • Annually
  • TwiceAnnually

Commitment Status

One of

  • Active
  • InactiveCancelled
  • Completed
  • InactiveFailed
  • Failing