Skip to main content
POST
/
v1
/
stores
/
{store}
/
subscription-plans
Create subscription plan
curl --request POST \
  --url https://api.confiopagos.com/v1/stores/{store}/subscription-plans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Premium Monthly Plan",
  "amountCents": 5000000,
  "description": "Access to all premium features with monthly billing",
  "currencyCode": "COP",
  "billingCycleFrequency": "MONTHLY",
  "billingCycleInterval": 1,
  "trialPeriodDays": 7
}
'
{
  "name": "organizations/01JNRR1NY8MDX4XCGG0N4F06X3/stores/01JNRRDZDPH40DB2YRW329BFXM/subscription-plans/01JNRVWWHH68E76V3TMFFT6GHJ",
  "displayName": "Premium Monthly Plan",
  "amountCents": 5000000,
  "currencyCode": "COP",
  "billingCycleFrequency": "MONTHLY",
  "billingCycleInterval": 1,
  "trialPeriodDays": 7,
  "status": "ACTIVE",
  "createTime": "2024-01-15T10:30:00Z",
  "updateTime": "2024-01-15T10:30:00Z",
  "description": "Access to all premium features"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
store
string
required
Example:

"01G65Z755AFWAKHE12NY0CQ9FH"

Body

application/json
​
displayName
string
required

Display name for the subscription plan

Required string length: 1 - 100
Example:

"Premium Monthly Plan"

​
amountCents
number
required

Subscription amount in cents

Required range: x >= 1000
Example:

5000000

​
description
string

Detailed description of the plan

Example:

"Access to all premium features with monthly billing"

​
currencyCode
string
default:COP

Currency code

Example:

"COP"

​
billingCycleFrequency
enum<string>
default:MONTHLY

Billing cycle frequency

Available options:
MONTHLY,
WEEKLY
Example:

"MONTHLY"

​
billingCycleInterval
number
default:1

Billing cycle interval (e.g., 1 = every month, 3 = every 3 months)

Required range: 1 <= x <= 12
Example:

1

​
trialPeriodDays
number
default:0

Trial period in days (0 = no trial)

Required range: 0 <= x <= 365
Example:

7

Response

200 - application/json

Successfully created subscription plan.

​
name
string
required

Subscription plan's resource name

Example:

"organizations/01JNRR1NY8MDX4XCGG0N4F06X3/stores/01JNRRDZDPH40DB2YRW329BFXM/subscription-plans/01JNRVWWHH68E76V3TMFFT6GHJ"

​
displayName
string
required

Display name of the plan

Example:

"Premium Monthly Plan"

​
amountCents
number
required

Amount in cents

Example:

5000000

​
currencyCode
string
required

Currency code

Example:

"COP"

​
billingCycleFrequency
enum<string>
required

Billing cycle frequency

Available options:
BILLING_FREQUENCY_UNSPECIFIED,
MONTHLY,
WEEKLY
Example:

"MONTHLY"

​
billingCycleInterval
number
required

Billing cycle interval

Example:

1

​
trialPeriodDays
number
required

Trial period in days

Example:

7

​
status
enum<string>
required

Plan status

Available options:
STATUS_UNSPECIFIED,
ACTIVE,
INACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
createTime
string
required

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
updateTime
string
required

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

​
description
string

Plan description

Example:

"Access to all premium features"