Isometric Stripe API

openapi: 3.2.0
info:
  description: '# Standards


    ## Versioning


    This API will be safely versioned using root path versioning, in the format `/v{major}`. For example, `/registry/v0/supplier`. ### Compatibility


    We won''t make breaking changes to existing API services or endpoints for API versions higher than `v0`. If breaking changes are necessary, we''ll release a new major version. We may deprecate APIs that have been replaced by a newer version. When doing so, we will expect

    integrated partners to manage a transition to new resources within the deprecation timeline of old ones. We will make the following sort of changes we do not consider to be breaking:


    - Adding new endpoints

    - Adding optional query parameters to API endpoints

    - Adding new properties to existing API responses

    - Reordering properties in existing API responses


    It is important that clients are built to be robust to these changes. ## Pagination


    Our API is based on the Relay pagination spec. Paginated endpoints

    will return a `PaginatedListResource` which contains:


    - `page_info` - Containing information regarding pagination cursors and the total number of entities. - `nodes` - Each node is a paginated entity. - `total_count` - The total size of the list across all pages. ### Pagination Parameters


    Paginated endpoints also accepted a standard set of query parameters:


    - `last` - An integer number of items to retrieve **before** the item represented by the cursor passed in the `before` parameter. Defaults to 10 with a maximum value of 50. - `before` - An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page''s `start_cursor` here when paginated backwards. - `first` - An integer number of items to retrieve **after** the item represented by the cursor passed in the `after` parameter. Defaults to 10 with a maximum value of 50. - `after` - An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page''s `end_cursor` here when paginated forwards. For example, querying `/registry/v0/beneficiaries` will return a `PaginatedListResource` of the first page of 10 items:


    ```json

    {

    "page_info": {

    "has_previous_page": false,

    "start_cursor": ...,

    "has_next_page": true,

    "end_cursor": "mpG5kcuoFBYtlH",

    },

    "nodes": [{

    "id": "org_12345iso678",

    "name": "My Org",

    ... }],

    "total_count": 100

    }

    ```


    Then querying `/registry/v0/beneficiaries?first=15&after=mpG5kcuoFBYtlH` will return a `PaginatedListResource` of the next 15 items. ## Dates


    Datetime fields in the APIs conform to the ISO 8601 date and time format in UTC. For example: `2024-01-22T11:56:48.520641Z`. ## Country Codes


    Countries are identified in the APIs via ISO 3166-1 Alpha-3 codes. For example: `GBR` and `USA`. # Authentication


    Most API requests will need to authenticate against the Isometric API in two ways simultaneously:


    - By passing a **client secret** in the `X-Client-Secret` header to identify the system integrating with the API. - By passing an **access token** in the `Authorization` header to authenticate as a specific organization, in order to gain access to its private data. ### Client Authentication


    Every API call to Isometric must include a **client secret** identifying the client application. This client secret is tied to a particular environment - sandbox or production. The client secret should be submitted on every API request via the `X-Client-Secret` header. For example `X-Client-Secret: uPrO...wxAh`. ### Organization Authentication


    In addition, a large number of API requests will require an **access token** in order for the caller to identify themselves and act as a specific Organization. To authenticate as an Organization you will need to submit a JWT bearer access token via the `Authorization` header. For example: `Authorization: Bearer eyJh...sw5c`.'
  title: Isometric Registry Stripe API
  version: v0
servers:
- description: Sandbox Isometric Registry API
  url: https://api.sandbox.isometric.com/registry/v0
- description: Production Isometric Registry API
  url: https://api.isometric.com/registry/v0
tags:
- name: Stripe
paths:
  /stripe/checkout:
    post:
      description: 'Create a Stripe Checkout Session for purchasing credits with Isometric verification.

        This endpoint returns a Stripe Checkout URL to redirect the user to for completing the payment.'
      operationId: create_stripe_checkout_session_stripe_checkout_post
      parameters:
      - description: A secret token identifying the client connecting to the API
        in: header
        name: x-client-secret
        required: true
        schema:
          description: A secret token identifying the client connecting to the API
          examples:
          - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
          title: Client secret
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateStripeCheckoutSessionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StripeCheckoutResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Create Stripe Checkout Session
      tags:
      - Stripe
  /stripe/configuration:
    get:
      description: 'Get Stripe configuration for the current organisation.

        This will return 404 if the current organisation is not set up for Stripe Connect.'
      operationId: get_stripe_configuration_stripe_configuration_get
      parameters:
      - description: A secret token identifying the client connecting to the API
        in: header
        name: x-client-secret
        required: true
        schema:
          description: A secret token identifying the client connecting to the API
          examples:
          - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP
          title: Client secret
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SupplierStripeConfiguration'
          description: Successful Response
        '404':
          description: Supplier not set up for Stripe Connect
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Get Stripe Configuration
      tags:
      - Stripe
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    StripeCheckoutResponse:
      properties:
        redirect_url:
          title: Redirect Url
          type: string
      required:
      - redirect_url
      title: StripeCheckoutResponse
      type: object
    StripeSubscriptionFrequency:
      enum:
      - one_time
      - monthly
      - yearly
      title: StripeSubscriptionFrequency
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    CreateStripeCheckoutSessionRequest:
      properties:
        cancel_url:
          description: The URL to redirect customer to after a cancelled or failed payment
          examples:
          - https://example.com/cancel
          title: Cancel Url
          type: string
        customer_email:
          anyOf:
          - type: string
          - type: 'null'
          description: The email of the customer to prefill the checkout session with. If not provided, the customer will be prompted to enter their email during checkout.
          examples:
          - test@example.com
          title: Customer Email
        frequency:
          $ref: '#/components/schemas/StripeSubscriptionFrequency'
          description: The frequency of the subscription
          examples:
          - monthly
        isometric_terms_and_conditions_accepted:
          description: Whether the user has accepted the Isometric terms and conditions; the request will fail if this is not set to true
          examples:
          - true
          title: Isometric Terms And Conditions Accepted
          type: boolean
        quantity_kg:
          description: The quantity of credits to purchase, in kilograms. This field can handle bigint values.
          examples:
          - 1000
          title: Quantity Kg
          type: integer
        success_url:
          description: The URL to redirect customer to after a successful payment
          examples:
          - https://example.com/success
          title: Success Url
          type: string
        supplier_terms_and_conditions_accepted:
          description: Whether the user has accepted the supplier terms and conditions; the request will fail if this is not set to true
          examples:
          - true
          title: Supplier Terms And Conditions Accepted
          type: boolean
      required:
      - quantity_kg
      - frequency
      - isometric_terms_and_conditions_accepted
      - supplier_terms_and_conditions_accepted
      - success_url
      - cancel_url
      title: CreateStripeCheckoutSessionRequest
      type: object
    SupplierStripeConfiguration:
      properties:
        account_id:
          description: Stripe account ID of the supplier's connected account
          title: Account Id
          type: string
        credit_product_price_per_tonne:
          anyOf:
          - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            type: string
          - type: 'null'
          description: Price per tonne for carbon dioxide removal; set by the supplier. See `currency` field for the currency.
          title: Credit Product Price Per Tonne
        currency:
          anyOf:
          - type: string
          - type: 'null'
          description: Currency used for this account (ISO 4217 code)
          title: Currency
        id:
          example: ssc_1EFF4PWKE1S0TF1S
          examples:
          - ssc_1EFF4PWKE1S0TF1S
          - ssc_1FH1888QSSBXWB18
          maxLength: 37
          minLength: 20
          title: Id
          type: string
        isometric_terms_and_conditions_url:
          description: URL to the Isometric terms and conditions
          title: Isometric Terms And Conditions Url
          type: string
        verification_product_price_per_tonne:
          anyOf:
          - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
            type: string
          - type: 'null'
          description: Price per tonne for verification; set by Isometric. See `currency` field for the currency.
          title: Verification Product Price Per Tonne
      required:
      - id
      - account_id
      - credit_product_price_per_tonne
      - verification_product_price_per_tonne
      - currency
      - isometric_terms_and_conditions_url
      title: SupplierStripeConfiguration
      type: object
  securitySchemes:
    HTTPBearer:
      bearerFormat: JWT
      description: 'A JWT Bearer token header for authentication and authorization, in the format `Authorization: Bearer <token>`'
      scheme: bearer
      type: http