Shops > Plan > planCreate
Commerce APIShopsPlanplanCreate
planCreate
POST:plan.json

Description

Switch shop's plan.

Permission bit: "shop_plan.modify"

Topic: Plan

Arguments

data: PlanCreate!

Main argument for mutations.


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

payment_method_id: String

Unique payment method identifier. See also: Unique Identifiers

Example: "pm_EQzGqWoY"

Valid when: payment_method_id matches regexp pattern: ^pm_


plan_id: String!

Unique plan identifier. See also: Unique Identifiers

Example: "medium"

Valid when: plan_id is not empty


token: String

Stripe payment method token

Example: "tok_123"


Result

Boolean

Preview (typescript)

Loading module