# Fetch a Subscription Plan

Retrieve the details of a previously created .

Endpoint: GET /subscription_plans/{subscription_plan_id}
Version: 2022-02-01
Security: BasicAuth

## Path parameters:

  - `subscription_plan_id` (string, required)
    The ID of the .

## Header parameters:

  - `Finix-Version` (string)
    Specify the API version of your request. For more details, see Versioning.
    Example: "2022-02-01"

## Response 200 fields (application/json):

  - `id` (string)
    The ID of the  resource.

  - `created_at` (string)
    Timestamp of when the object was created.

  - `updated_at` (string)
    Timestamp of when the object was last updated.

  - `linked_to` (string)
    he ID of the [](#Merchants) resource that you wish to link to the  (i.e., the merchant that the subscription plan belongs to).

At this time, only approved merchants with one of the following processors are valid:

- 
-

  - `linked_type` (string)
    The type of the resource that is specified in the  field.
    Enum: "MERCHANT"

  - `billing_interval` (string)
    How often the subscriber is billed.
    Enum: "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY"

  - `nickname` (string)
    A human-readable name for the resource.
    Example: "super important thing"

  - `plan_name` (string)
    A human-friendly name for the .

  - `description` (string)
    A description of the .

  - `amount` (integer)
    The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

  - `currency` (string)
    ISO 4217 3-letter currency code. Currently, the only  supported is .
    Enum: "USD"

  - `billing_defaults` (object)
    Object containing default billing settings.

  - `billing_defaults.collection_method` (string)
    The method by which subscription payments are collected. Currently, automatically billing the card on file is the only method available.
    Enum: "BILL_AUTOMATICALLY"

  - `billing_defaults.send_invoice` (boolean)
    This feature has yet to be implemented.

  - `billing_defaults.send_receipt` (boolean)
    This feature has yet to be implemented.

  - `trial_defaults` (object)
    Object containing default trial settings.

  - `trial_defaults.interval_type` (string)
    The unit of time for the trial period.
    Enum: "DAY", "WEEK", "MONTH", "YEAR"

  - `trial_defaults.interval_count` (integer)
    The number of intervals of  used to describe the duration of the trial.

  - `discount_phase_defaults` (object)

  - `discount_phase_defaults.billing_interval_count` (integer)
    The number of billing intervals the discount applies. After this period, the subscriber is charged the full .

  - `state` (string)
    The state of the .
    Enum: "ACTIVE", "INACTIVE"

  - `tags` (object,null)
    Include up to 50  pairs to annotate requests with custom metadata.
- Maximum character length for individual  is 40.
- Maximum character length for individual  is 500.
(For example, , , )

  - `_links` (object)
    An object containing link(s) relevant to the request. You can store these links for follow-up requests.

  - `_links.self` (object)

  - `_links.self.href` (string)
    The path to the new  resource.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 404 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 422 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "INVALID_FIELD"

  - `_embedded.errors.field` (string)

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)