Create Rate Card

Authorization

api_key

x-access-token<token>

In: header

Request Body

application/json

Input for creating a new rate card

name*string

Name of the rate card

description?|

Description of the rate card

minimum_amount?number

Minimum amount to bill per period

Formatdouble

minimum_period?APIRatePeriod

Period for minimum amount billing

Value in

"DAILY"
"WEEKLY"
"BIWEEKLY"
"MONTHLY"
"YEARLY"

subscription_amount?number

Subscription amount to bill per period

Formatdouble

subscription_period?APIRatePeriod

Period for minimum amount billing

Value in

"DAILY"
"WEEKLY"
"BIWEEKLY"
"MONTHLY"
"YEARLY"

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/shipos/rate-cards" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "team_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "string",  "subscription_period": "DAILY",  "subscription_amount": 0.1,  "minimum_period": "DAILY",  "minimum_amount": 0.1,  "description": "string",  "name": "string",  "id": "string"}

Create Rate Card

Authorization

Request Body

Response Body

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

422application/problem+json

429application/problem+json

500application/problem+json

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`