Contents x
    Get all subscription types
    • 06 Sep 2024
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Contents

    Get all subscription types

    • Updated on 06 Sep 2024
    • 2 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    Article summary

    Get
    /subscription/v4/types

    Get all latest subscription types (paginated).

    Security
    HTTP
    Type bearer
    Query parameters
    status
    string
    Valid values[ "\"DRAFT\"", "\"ACTIVE\"", "\"LEGACY\"", "\"ARCHIVED\"" ]
    limit
    integer
    Minimum0
    Maximum100
    cursor
    string
    Responses
    200

    Get all subscription types.

    Expand All
    object
    meta
    object
    pagination
    object
    moreResults
    boolean

    True if there are more results.

    items
    number

    Number of items returned.

    cursor
    string

    Cursor from request to start from.

    nextCursor
    string

    Cursor to start from for next page.

    data
    Array of object
    object
    typeId
    string

    The unique identifier of the subscription type, in UUID format.

    name
    string

    Display name for the subscription

    status
    string

    The status of the subscription type. DRAFT - All new Subscription Types are created in this state. Subscription Types in this state need to be activated before they can be used to create a Subscription Contract ACTIVE - Subscription Types in this state can be used to create Subscription Contracts LEGACY - Subscription Types are transitioned to this state when deactivated ARCHIVED - Not yet used.

    Valid values[ "\"DRAFT\"", "\"ACTIVE\"", "\"LEGACY\"", "\"ARCHIVED\"" ]
    shortDescription
    string

    A short description of the subscription type, up to 80 characters. Useful for display purposes.

    Max length80
    ExampleA weekly box of fresh fruit and vegetables.
    description
    string

    Long description of the subscription type.

    ExampleA weekly box of fresh fruit and vegetables delivered to your door. Perfect for busy families and individuals who want to eat healthily.
    updatedAt
    string

    The date and time when the subscription type was last updated.

    400

    Invalid Request

    Expand All
    object
    message
    string

    A human readable message describing the error.

    causes
    Array of object

    A list of causes for the error.

    object
    message
    string

    A human readable message describing the cause of the error.

    metadata

    A list of metadata describing the cause of the error.

    401

    Invalid Authentication Credentials

    Expand All
    object
    message
    string

    A human readable message describing the error.

    causes
    Array of object

    A list of causes for the error.

    object
    message
    string

    A human readable message describing the cause of the error.

    metadata

    A list of metadata describing the cause of the error.

    403

    Invalid Authorization Credentials

    Expand All
    object
    message
    string

    A human readable message describing the error.

    causes
    Array of object

    A list of causes for the error.

    object
    message
    string

    A human readable message describing the cause of the error.

    metadata

    A list of metadata describing the cause of the error.

    500

    Internal Server Error

    Expand All
    object
    message
    string

    A human readable message describing the error.

    causes
    Array of object

    A list of causes for the error.

    object
    message
    string

    A human readable message describing the cause of the error.

    metadata

    A list of metadata describing the cause of the error.

    Was this article helpful?
    What's Next