Get Plan by Id

Get Recurrence Plan by Id

This endpoint retrieves detailed information about a specific recurrence plan using its unique plan_id. It is useful for viewing the configuration of a subscription plan, including billing cycle, payment methods, and amount.

Usage Scenarios:
- Retrieving full details of a recurrence plan for display or review.
- Validating a specific plan’s configuration before customer subscription.

Notes:
- Requires the plan_id as a path parameter in UUIDv4 format.
- The x-seller-id header is mandatory to identify the requesting merchant.
- Returns full plan metadata including period, amount, currency, payment types, and floating data if applicable.
- Ensures that only plans associated with the authenticated seller are accessible.

请求参数

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 参数

Query 参数

返回响应

🟢200

application/json

Bodyapplication/json

示例

{
    "seller_id": "28f4dc41-8499-4ead-9976-f2fa20a45fd1",
    "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
    "name": "string",
    "description": "string",
    "amount": 0,
    "currency": "str",
    "sales_tax": 0,
    "product_type": "cash_carry",
    "payment_types": [
        "credit_card"
    ],
    "status": "active",
    "create_date": "2019-08-24T14:15:22.123Z",
    "period": {
        "type": "yearly",
        "billing_cycle": 12,
        "specific_cycle_in_days": 1
    },
    "floating_data": [
        {
            "installment": 1,
            "amount": 0
        }
    ]
}

🟠400

🟠404

🟠422

🔴500

请求参数

请求示例代码

返回响应