POST
/
v1
/
c
/
contract

Authorizations

wb-key
string
headerrequired

Body

application/json
activation
string | null

Contract activation date. Immediate if empty

automatic_payment
boolean | null

Whether the Customer should be charged by Wingback Billing Engine or not If not set, the configuration from Customer profile will be used, and if that is not set either, the default configuration for WbCustomer will be used

currency
enum<string>
required

A supported currency

The format for parsing and reading is the lowercased ISO 4217 currency code (e.g. "usd")

Available options:
usd,
eur
customer
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

cycle
enum<string>
required

Enum that lists supported payment cycles for contracts:

  • Once - one-time payment
  • Constant - one-time payment for the duration of the contract
  • Week - contract is paid weekly
  • Month - contract is paid monthly
  • Quarter - contract is paid every quarter
  • Year - contract is paid yearly
Available options:
once,
hour,
day,
week,
month,
quarter,
year,
constant
discount_id
string

Unique identifier of an object. Consists of object class prefix and a UUID

feature_configuration
object | null

Configuration specifying overrides to apply to new plan during contract upgrade. In addition to the number of units to purchase, it is possible to override price and flat_fee of specific features to create customized plans See FeatureConfiguration for format

invoice_trigger

When the invoices should be created

Note: EveryCycle and Periodic aren't yet supported, they will behave as Manual

Available options:
immediate
is_pending
boolean

Creates a pending contract. Pending contract has no activation date, and can only be activated manually. Activation date is ignored if this is set to true. Defaults to false

plan
string
required

Unique identifier of an object. Consists of object class prefix and a UUID

pricing_id
string

Unique identifier of an object. Consists of object class prefix and a UUID

unit_count_configuration
object | null
deprecated

Configuration specifying the number of units to purchase on the new plan for unit-based features. This is a hashmap where keys are slugs of features, and values are the numbers of units to purchase { "{feature_slug}": {number_of_units} }

Delete AddressRetrieve Contract Details