Create contract

post https://api.zenskar.com/contract_v2

Create a new contract

Responses

Response body

object

uuid

required

Contract ID

name

string

required

Contract name

description

string

Contract Description

Tags

status

string

required

An enumeration.

draft active paused expired disputed

currency

string

required

Currency

start_date

date-time

Start Date

end_date

date-time

End Date

custom_attributes

object

Contract Tags

Has additional fields

created_at

date-time

required

Contract created at

updated_at

date-time

required

Contract updated at

customer_id

uuid

required

Customer ID

anchor_date

date-time

Anchor Date

plan_id

uuid

Plan ID

renewal_policy

string

Enum for defining the renewal policy of a contract.

renew_with_default_contract renew_with_existing do_not_renew

phases

array of objects

Defaults to

Different Contract Phases

Phases

object

name

string

required

Contract Phase name

description

string

Contract Phase Description

start_date

date-time

Start Date

end_date

date-time

End Date

uuid

required

Contract Phase ID

created_at

date-time

required

Contract Phase created at

updated_at

date-time

required

Contract Phase updated at

contract_id

uuid

required

Contract ID

features

object

Pricing for the features of the phase

pricings

array of objects

Defaults to

Different Product Pricings

Pricings

object

uuid

required

Contract Phase Pricing ID

external_id

string

External ID

start_date

date-time

Start Date

end_date

date-time

End Date

phase_id

uuid

required

Contract Phase ID

pricing_id

uuid

required

Pricing ID

product_id

uuid

required

Product ID

created_at

date-time

required

Contract Phase Pricing created at

updated_at

date-time

required

Contract Phase Pricing updated at

product

object

required

Product details

pricing

object

required

Pricing details

custom_data

object

Pricing Association Metadata

Has additional fields

source_plan_phase_id

uuid

Source Plan Phase ID

phase_type

string

Defaults to active

An enumeration.

active pause trial

phase_metadata

object

Phase Metadata

Has additional fields

customer

object

required

Create Customer Response Schema

uuid

required

Customer Id

external_id

string

required

External Customer Id

customer_name

string

required

Customer name

custom_data

object

required

Customer Custom Data

Has additional fields

address

object

required

Address Schema

ship_to_address

object

Address Schema

tax_info

array of objects

Defaults to

Customer Tax Ids

Tax Info

object

country_code

string

Country Code

tax_code

string

Tax Code

tax_id

string

Tax Id

string

Customer primary email address

custom_attributes

object

Customer Tags

Has additional fields

phone_number

string

Customer Phone Number

communications_enabled

boolean

Defaults to true

To enable/disable communications

auto_charge_enabled

boolean

Defaults to true

To enable/disable auto-charge

business_entity_id

uuid

Business Entity Id

current_phase

object

Current Contract Phase

name

string

required

Contract Phase name

start_date

date-time

Start Date

end_date

date-time

End Date

uuid

required

Contract Phase ID

phase_type

string

Defaults to active

An enumeration.

active pause trial

phase_metadata

object

Phase Metadata

Has additional fields

contract_link

string

Contract Link

bill_parent_customer

boolean

Defaults to false

Bill Parent Customer

Language


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.zenskar.com/contract_v2 \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "status": "draft",
8
  "bill_parent_customer": false
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error