Skip to main content

Contract

An agreement between the merchant and somebody they do business with.

type Contract {
  contractValue: Money
  id: ID!
  title: String!
  counterparty: String!
  status: ContractStatus!
  effectiveDate: Date!
  renewalDate: Date
}

Fields​

Contract.contractValue ● Money object​

What the parties agreed the agreement is worth, or null when it carries no single figure — a revenue share, or an agreement priced per order.

**Returns:** The agreed value, or null.

Contract.id ● ID! non-null scalar​

The stable identifier of this agreement, unique across every merchant.

Contract.title ● String! non-null scalar​

What the agreement is called, in the merchant's own words.

Contract.counterparty ● String! non-null scalar​

Who the merchant signed it with.

Contract.status ● ContractStatus! non-null enum​

Where the agreement stands.

Contract.effectiveDate ● Date! non-null scalar​

The day the agreement started to apply, in UTC.

Contract.renewalDate ● Date scalar​

The day the agreement next falls due for renewal, in UTC, or null when it does not renew. A date in the past does not change status on its own — somebody at the merchant decides that.

Returned By​

contract query

Member Of​

ContractConnection object ● ContractEdge object ● Document object