Update Plan status

Update Plan status

This endpoint allows you to update the status of an existing recurrence plan. You can use it to activate or deactivate (inactive) a plan depending on your business needs. It is commonly used for enabling or pausing plans without deleting them.

Usage Scenarios:
- Activating a new plan after initial setup.
- Temporarily deactivating a plan that is no longer available for new subscriptions.
- Enabling or disabling a plan based on promotional periods or internal business rules.

Notes:
- The plan_id must be provided in the path of the request URL.
- The new status (active or inactive) is also passed as a path parameter.

请求参数

Authorization

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api.pre.globalgetnet.com/authentication/oauth2/access_token

OAuth 2.0

Client Credentials

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Token URL: https://api-sbx.globalgetnet.com/authentication/oauth2/access_token

Scopes:

digital-platform:gateway-api-Read and write access

Path 参数

Header 参数

返回响应

🟢200

application/json

Returns plan data.

Bodyapplication/json

示例

{
    "seller_id": "6eb2412c-165a-41cd-b1d9-76c575d70a28",
    "plan_id": "51995e24-b1ae-4826-8e15-2a568a87abdd",
    "name": "Plano flex",
    "description": "Flex plan",
    "amount": 19990,
    "currency": "BRL",
    "payment_types": "credit_card",
    "sales_tax": 0,
    "product_type": "cash_carry",
    "create_date": "2017-04-19T16:30:30Z",
    "status": "active",
    "period": {
        "type": "yearly",
        "billing_cycle": 12,
        "specific_cycle_in_days": 1
    },
    "floating_data": [
        {
            "installment": 2,
            "amount": 19990
        }
    ]
}

🟠400

🟠404

🟠422

🔴500

请求参数

请求示例代码

返回响应