Update Product

POST

products

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

Path Params

{product_api_id}

string

required

The name of the product. Must be unique.

Body Params

name

string

The name of the product. Must be unique.

base_px

float

The base price of the product in USD.

interval

string

A string value denoting how often to bill for a subscription. Possible values: day, week, month, year, one_time.

interval_count

integer

An integer denoting how many intervals to bill for the. A monthly product would have month as interval and 1 as interval counts, etc. One time products should have an interval count of 1.

country_prices

[object]

A list of one ore more of the below country price object. Country prices provided during an update call with overwrite any existing ones.

Show <country_price>

country

enum

required

Two-letter ISO3166 country code.

amount

float

required

The price of the product in this country.

currency

enum

required

The three-letter ISO4217 currency code of the price in this country.

integrations

[object]

A list of one or more of the below integration price objects. Integration objects provided during an update call with overwrite any existing ones.

Show <stripe>

type

string

required

Should be set to equal stripe.

stripe_product_id

stripe

required

The matching Stripe product ID.

Show <stripe_with_interval>

type

string

required

Should be set to equal stripe_with_interval.

stripe_product_id

string

required

The matching Stripe product ID.

interval

enum

required

The frequency at which a subscription is billed. One of day, week, month or year. Sometimes Stripe products actually encompass more than what Corrily would consider a product. For example, the Stripe product for a company’s “Pro Plan” might have two Price objects one for the monthly version of the plan, the other for its annual version. Meanwhile, Corrily would consider these to be two distinct products pro_monthly and pro_annual. To capture such differences you can pass a stripe_with_interval integration object which can help separate such cases.

interval_count

integer

required

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

Show <chargebee>

type

string

required

Should be set to equal chargebee.

chargebee_plan_id

string

required

The matching Chargebee plan ID.

Show <recurly>

type

string

required

Should be set to equal recurly.

recurly_plan_id

string

required

The matching Recurly plan ID.

currency

string

required

Currency value

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

POST

products

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

Path Params

{product_api_id}

string

required

The name of the product. Must be unique.

Body Params

name

string

The name of the product. Must be unique.

base_px

float

The base price of the product in USD.

interval

string

A string value denoting how often to bill for a subscription. Possible values: day, week, month, year, one_time.

interval_count

integer

An integer denoting how many intervals to bill for the. A monthly product would have month as interval and 1 as interval counts, etc. One time products should have an interval count of 1.

country_prices

[object]

A list of one ore more of the below country price object. Country prices provided during an update call with overwrite any existing ones.

Show <country_price>

country

enum

required

Two-letter ISO3166 country code.

amount

float

required

The price of the product in this country.

currency

enum

required

The three-letter ISO4217 currency code of the price in this country.

integrations

[object]

A list of one or more of the below integration price objects. Integration objects provided during an update call with overwrite any existing ones.

Show <stripe>

type

string

required

Should be set to equal stripe.

stripe_product_id

stripe

required

The matching Stripe product ID.

Show <stripe_with_interval>

type

string

required

Should be set to equal stripe_with_interval.

stripe_product_id

string

required

The matching Stripe product ID.

interval

enum

required

interval_count

integer

required

The number of intervals (specified in the interval attribute) between subscription billings. For example, interval=month and interval_count=3 bills every 3 months.

Show <chargebee>

type

string

required

Should be set to equal chargebee.

chargebee_plan_id

string

required

The matching Chargebee plan ID.

Show <recurly>

type

string

required

Should be set to equal recurly.

recurly_plan_id

string

required

The matching Recurly plan ID.

currency

string

required

Currency value

curl --location -g --request POST 'https://client.corrily.com/v1/products/monthly' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Monthly Product",
    "base_px": 10,
    "interval": "month",
    "interval_count": 1,
    "country_prices": [
        {
            "country": "ES",
            "amount": 50,
            "currency": "EUR"
        }
    ],
    "integrations": [
        {
            "type": "stripe",
            "stripe_product_id": "my_stripe_pid"
        }
    ]
}'

Path Params

Body Params

Prices

Paywall

Users

Subscriptions

Charges

Products

Coupons

Update Product

Path Params

Body Params

​Path Params

​Body Params

Prices

Paywall

Users

Subscriptions

Charges

Products

Coupons

​Path Params

​Body Params

Path Params

Body Params

Path Params

Body Params