Stripe Subscription

POST 
/v1/stripe/subscribe

Create stripe subscription checkout session url and send it to front end

Request

application/json

Body

required

organization_id Organization Id (string)required

Organization ID

plan_type OrganizationPlan (string)

Possible values: [atlas_demo, atlas_enterprise, atlas_team, atlas_plus, atlas_research, atlas_starter, atlas_startup, atlas_pro, mock, free_test_user, pro, enterprise, free, research]

Default value: pro

The master list of available plans for organizations.

promo_code

object

Promotion code

anyOf

MOD1

string

enable_free_trial Enable Free Trial (boolean)

Should a free trial period be enabled for the plan.

Responses

200

Successful Response

application/json

Schema

Schema

subscription_id Subscription Id (string)required

The ID of the subscription

client_secret Client Secret (string)required

The stripe client secret for the payment entering session

intent_type Intent Type (string)required

Possible values: [payment, setup]

The type of intent to create

applied_promo_code

object

The applied promo code, if successful

anyOf

MOD1

string

promo_code_description

object

Description of promo code (metadata.descrption in Stripe), if available

anyOf

MOD1

string

Example (from schema)

{
  "subscription_id": "string",
  "client_secret": "string",
  "intent_type": "payment",
  "applied_promo_code": "string",
  "promo_code_description": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...