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

# Show a subscription



## OpenAPI

````yaml https://app.dimepayments.com/openapi.yaml get /api/subscription/show
openapi: 3.0.3
info:
  title: Dime Payments API Documentation
  description: >-
    A simple, basic API for managing Merchants through Dime Payments. JSON based
    REST API
  version: 1.0.0
servers:
  - url: https://app.dimepayments.com
security:
  - default: []
tags:
  - name: Merchant management
    description: ''
  - name: Transaction management
    description: >-

      APIs for managing transactions.  Depending on API KEY permissions, one
      should be able to

      charge credit cards, ACH, Google/Apple Pay wallets along with other
      functions.
  - name: Addresses
    description: |-

      APIs for managing customer addresses
  - name: Customer management
    description: >-

      APIs for managing customers.  Depending on API KEY permissions, one should
      be able to

      list, create, update, and delete customers along with several other
      customer specific requests.
  - name: Deposit management
    description: ''
  - name: Invoice management
    description: >-

      APIs for managing invoices. Depending on API KEY permissions, one should
      be

      able to list, create, update, delete, and send invoices, manage their line

      items, and manage recurring-invoice schedules. Every request is scoped to
      a

      single Merchant via the required `data.sid`.
  - name: Payment Method management
    description: >-

      APIs for managing payment methods associated with customers.  Depending on
      API KEY permissions, one should be able to

      list, show, create, update, and delete payment methods.
  - name: Recurring Payments management
    description: >-

      APIs for managing recurring payments.  Depending on API KEY permissions,
      one should be able to

      create, edit, pause, cancel along with other functions.
  - name: Subscription Plans management
    description: >-

      Merchant-facing API for subscription plans (recurring offerings customers

      subscribe to). The merchant is identified by `data.sid`; the token must
      carry

      the matching `subscription-plan:*` ability. Mirrors the recurring-payment
      and

      invoice API controllers.
  - name: Subscriptions management
    description: >-

      Merchant-facing API for individual customer subscriptions (enrollments in
      a

      plan). The merchant is identified by `data.sid`; the token must carry the

      matching `subscription:*` ability. Lifecycle transitions delegate to the

      {@see \App\Actions\Subscription} action classes so the matching
      `SUBSCRIPTION_*`

      webhook always fires. Mirrors the recurring-payment and subscription-plan
      API

      controllers.
  - name: Zapier
    description: >-

      APIs for use through Zapier.  Depending on API KEY permissions, one should
      be able to

      see customers and transactions data.
paths:
  /api/subscription/show:
    get:
      tags:
        - Subscriptions management
      summary: Show a subscription
      operationId: showASubscription
      parameters: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: object
                  description: ''
                  example:
                    sid: 12345
                  properties:
                    sid:
                      type: integer
                      description: The merchant SID.
                      example: 12345
                    subscription_id:
                      type: integer
                      description: The subscription id.
                      example: 42
                  required:
                    - sid
                    - subscription_id
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    id: null
                    subscription_plan_id: 99
                    plan_name: Monthly Membership 30805
                    amount: '0.00'
                    recurrence_schedule: Monthly
                    start_date: '2026-07-20T04:00:00.000000Z'
                    end_date: null
                    last_run_date: null
                    last_run_status: null
                    last_run_failed_count: 0
                    next_run_date: '2026-09-20T04:00:00.000000Z'
                    status: Active
                    paused_until_date: null
                    cancelled_at: null
                    cancelled_by: null
                    customer_uuid: 5420c9b1-56c1-4910-9510-a58db8ebda63
                    error: null
                    payment_method:
                      id: 5994
                      type: cc
                      last_four: '1161'
                      expiration: 08/2030
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        example: null
                        nullable: true
                      subscription_plan_id:
                        type: integer
                        example: 99
                      plan_name:
                        type: string
                        example: Monthly Membership 30805
                      amount:
                        type: string
                        example: '0.00'
                      recurrence_schedule:
                        type: string
                        example: Monthly
                      start_date:
                        type: string
                        example: '2026-07-20T04:00:00.000000Z'
                      end_date:
                        type: string
                        example: null
                        nullable: true
                      last_run_date:
                        type: string
                        example: null
                        nullable: true
                      last_run_status:
                        type: string
                        example: null
                        nullable: true
                      last_run_failed_count:
                        type: integer
                        example: 0
                      next_run_date:
                        type: string
                        example: '2026-09-20T04:00:00.000000Z'
                      status:
                        type: string
                        example: Active
                      paused_until_date:
                        type: string
                        example: null
                        nullable: true
                      cancelled_at:
                        type: string
                        example: null
                        nullable: true
                      cancelled_by:
                        type: string
                        example: null
                        nullable: true
                      customer_uuid:
                        type: string
                        example: 5420c9b1-56c1-4910-9510-a58db8ebda63
                      error:
                        type: string
                        example: null
                        nullable: true
                      payment_method:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 5994
                          type:
                            type: string
                            example: cc
                          last_four:
                            type: string
                            example: '1161'
                          expiration:
                            type: string
                            example: 08/2030
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: >-
        You can retrieve your token by visiting your dashboard and clicking
        <b>Generate API token under your profile in top right</b>.

````