ProsperStack Customer Portal API

openapi: 3.2.0
info:
  title: ProsperStack API Reference Customer Portal API
  version: v1
  description: 'This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at prosperstack.com.


    For more information on ProsperStack features, see the primary documentation.


    Let us know how we can improve the API, documentation or anything else you need help with at support@prosperstack.com.


    # Introduction


    The ProsperStack API provides a REST-like interface to your ProsperStack data. It uses standard HTTP verbs, accepts JSON-encoded request bodies and provides JSON-encoded responses.


    You can use the ProsperStack API to access your live production data or data from test mode. The API key you use to authenticate requests determines which mode will be used.


    # Authentication


    The ProsperStack API uses API keys to authenticate requests. You can manage your API keys from the ProsperStack API Keys settings page.


    Live mode API keys have the prefix `key_` and test mode API keys have the prefix `key_test_`.


    Authentication uses HTTP basic authentication. Provide your API key as the basic authentication username. You don''t need to provide a password.


    A simple example using cURL:


    ```bash

    curl https://api.prosperstack.com/v1/flow_sessions \

    -u key_LSdJXBrN3SP7bdJrQSMp2eZK:

    ```


    Learn more about creating API keys.


    # Pagination


    All list endpoints support cursor-based pagination. The body of a list response will contain a `data` property with an array of objects and a `next_cursor` property desginating the cursor value to retrieve the next set of results.


    Use the value of `next_cursor` in the `cursor` query parameter to specify the set of results to return. If `next_cursor` is `null`, there are no more results.


    You can also specify a `limit` in the query parameters to adjust the number of items per result set. The limit defaults to 10 and has a maximum of 100.


    # Rate limits


    The ProsperStack API enforces a rate limit of 100 requests per minute. Your live mode and test mode accounts have separate limits.


    When the rate limit is exceeded, requests will fail with the HTTP status `429 Too Many Requests` until the limit window resets.


    The ProsperStack API implements the RateLimit Header Fields for HTTP draft which describes a set of HTTP headers you can use to observe current request limits.


    The headers are:


    - `RateLimit-Limit` — The limit of requests per time window (1 minute)

    - `RateLimit-Remaining` — The number of requests left before exceeding the limit

    - `RateLimit-Reset` — The number of seconds until the limit window resets


    If you need to exceed the rate limit, let us know at support@prosperstack.com and we''ll be happy to help.'
  x-logo:
    url: https://prosperstack.com/images/logo-api.svg
servers:
- url: https://api.prosperstack.com/v1
security:
- basicAuth: []
tags:
- name: Customer Portal
  x-displayName: Customer portal
  description: 'The customer portal allows customers to self-manage their subscriptions and billing details.


    Creating a portal session creates a unique URL for a specific customer. Create sessions via the API to seamlessly log customers in to the portal directly from your application or website.'
paths:
  /customer_portal/sessions:
    post:
      summary: Create a customer portal session
      operationId: createCustomerPortalSession
      tags:
      - Customer Portal
      requestBody:
        $ref: '#/components/requestBodies/CustomerPortalSession'
      responses:
        '201':
          description: Created
          headers:
            Location:
              description: The URL of the created customer portal session
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerPortalSession'
        '400':
          description: Bad Request
          $ref: '#/components/responses/Error'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/Error'
        '409':
          description: Conflict
          $ref: '#/components/responses/Error'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    CustomerPortalSession:
      type: object
      required:
      - id
      - url
      - created_at
      - expires_at
      properties:
        id:
          type: string
          example: psess_ShhcPknbB0aaPNk2jyOQajsH
        url:
          type: string
          format: uri
          description: The URL of the created customer portal session
          example: https://app.prosperstack.com/p/portal/acct_6Ggu2ID13p2iPA3PPEP1e6Ps/session/psess_ShhcPknbB0aaPNk2jyOQajsH
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
  requestBodies:
    CustomerPortalSession:
      content:
        application/json:
          schema:
            type: object
            required:
            - platform_subscriber_id
            - return_url
            properties:
              platform_subscriber_id:
                type: string
                example: cus_Ne8IAatISPUTNi
                description: The ID of the customer from your connected subscription platform
              return_url:
                type: string
                format: uri
                description: The URL to redirect customers to when they leave the customer portal
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic