> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Subscription Config

## Endpoint Overview

**GET** `https://api.unibee.dev/merchant/subscription/config`

Subscription Config

***

## Authorization

All UniBee Merchant API requests require authentication via API key.

| Header          | Required | Description                           |
| --------------- | -------- | ------------------------------------- |
| `Authorization` | Yes      | Bearer `<your_api_key>`               |
| `Content-Type`  | Yes      | `application/json` (for request body) |

***

## Parameters

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

Path, query, and request body parameters are defined in the schema below. Use the interactive Try it panel to see the full request structure.

***

## Request examples

### cURL

```bash theme={null}
curl -X GET "https://api.unibee.dev/merchant/subscription/config" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"
```

### Sandbox

```bash theme={null}
curl -X GET "https://api-sandbox.unibee.top/merchant/subscription/config" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"
```

***

## Response

Success responses return a JSON envelope with `code`, `data`, `message`, `redirect`, and `requestId`. `code` `0` indicates success.

| Field         | Type    | Description                  |
| ------------- | ------- | ---------------------------- |
| `code`        | integer | Response code. `0` = success |
| `data`        | object  | Response payload             |
| `data.config` | object  |                              |
| `message`     | string  | Human-readable message       |
| `requestId`   | string  | Request ID for support       |

***

## Error handling

| HTTP status | Meaning                                                                   |
| ----------- | ------------------------------------------------------------------------- |
| 400         | Bad request — invalid or missing parameters. Check `message` in the body. |
| 401         | Unauthorized — missing or invalid API key.                                |
| 404         | Not found — invalid path or resource.                                     |
| 500         | Server error — retry with backoff.                                        |

When `code` in the response body is non-zero, check `message` for details. Use `requestId` when contacting support.


## OpenAPI

````yaml get /merchant/subscription/config
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202603161017
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/subscription/config:
    get:
      tags:
        - Subscription Config
      summary: Subscription Config
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties:
                      config:
                        $ref: >-
                          #/components/schemas/unibee.api.bean.SubscriptionConfig
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  schemas:
    unibee.api.bean.SubscriptionConfig:
      properties:
        downgradeEffectImmediately:
          description: >-
            DowngradeEffectImmediately, whether subscription update should
            effect immediately or at period end, default at period end
          format: bool
          properties: {}
          type: boolean
        downgradeNonImmediatelyEffectBeforePeriodEnd:
          description: >-
            DowngradeNonImmediatelyEffectBeforePeriodEnd, for non-immediate
            downgrade, can take effect before period end (in seconds), default
            30 minutes (1800)
          format: int64
          properties: {}
          type: integer
        fiatExchangeApiKey:
          format: string
          properties: {}
          type: string
        gatewayVATRule:
          format: string
          properties: {}
          type: string
        incompleteExpireTime:
          description: IncompleteExpireTime, em.. default 1day for plan of month type
          format: int64
          properties: {}
          type: integer
        invoiceEmail:
          description: InvoiceEmail, whether to send invoice email to user, default yes
          format: bool
          properties: {}
          type: boolean
        invoicePdfGenerate:
          description: >-
            InvoicePdfGenerate, whether to generate invoice pdf to user, default
            yes
          format: bool
          properties: {}
          type: boolean
        showZeroInvoice:
          description: ShowZeroInvoice, show zero invoice or not, default no
          format: bool
          properties: {}
          type: boolean
        tryAutomaticPaymentBeforePeriodEnd:
          description: TryAutomaticPaymentBeforePeriodEnd, default 30 min
          format: int64
          properties: {}
          type: integer
        upgradeProration:
          description: >-
            UpgradeProration, whether subscription update generation proration
            invoice or not, default yes
          format: bool
          properties: {}
          type: boolean
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````