Goodstack Eligibility Subscriptions API

openapi: 3.2.0
info:
  title: Goodstack Services Eligibility Subscriptions API
  version: v1
  x-logo:
    url: https://docs.goodstack.io/img/logo.png
    altText: Goodstack logo
  x-dark-logo:
    url: https://docs.goodstack.io/img/icons/Logo-white.svg
    altText: Goodstack logo
  contact:
    email: engineering-support@goodstack.io
    name: Api support
  description: '# Introduction


    Goodstack API allows you to build good into your product by facilitating charitable donations. We achieve this through the API''s listed and specified in this documentation. For all donations using the Goodstack API, Goodstack handles the vetting and validation of the good causes and onward the disbursement of the donation. The Goodstack API is organised around REST. All API responses, including errors, return JSON and use standard HTTP response codes. In all API requests you must specify the content-type HTTP header as application/json. All API requests must be made over HTTPS. # Authentication


    Authenticate your API requests by setting your live secret API key in the Authorization header. Two keys are provided to you, a publishable key prefixed with `pk_` and a secret key prefixed with `sk_`. Publishable API keys are meant solely to identify your goodstack account. These can safely be published in places like your JavaScript code, or in an Android or iPhone app and are meant for usage with our SDKs. Secret API keys should be kept confidential and only used in secure server environments. Anywhere that accepts a Publishable key will also accept a Secret key, but routes marked to accept a Secret key will not accept a Publishable key. # Formats


    ## IDs


    All ID fields are case-sensitive. For example, `abc123` and `ABC123` are treated as different IDs. ## Dates


    Dates are encoded as strings following the ISO 8601 standard `2025-08-01T12:00:00.000Z`. ## Pagination


    A maximum of 100 objects can be returned per request and the limit can be specified by using the pageSize query parameter. By default, the pageSize is set to 25. A `_links` object is included in paginated responses, which contains `next` and `prev` URLs to retrieve the next or previous pages of results. ## Monetary Values


    Throughout the API, monetary values are encoded as integers representing the amount in the smallest currency unit, for example 100 cents for a donation of $1.00. Currency is encoded as a string following the ISO 4217 standard (e.g. `USD`). ## Metadata


    Some objects have a metadata parameter that you can use to store key-value data. You can specify up to 20 keys, with key names up to 40 characters long and values up to 250 characters long. ## Errors


    The API returns standard HTTP response codes to indicate success or failure of API requests. Errors may include a custom error message. Error objects have these attributes, an `id`, a `message` corresponding to the HTTP response phrase of the error,

    an optional `invalid-params` attribute detailing issues with the request. An example error object returned from the API:

    ```json

    {

    error: {

    code: ''bad_request'',

    title: ''Bad request'',

    message: ''Something is wrong with your request, please check any parameters and try again'',

    reasons: [''amount is a required field'']

    }

    }

    ```


    A summary of the HTTP status codes returned from the api is listed in the table below. | Code | Title | Description |

    | ------------- |-------------| -----|

    | 200 | Success | Request successful |

    | 204 | No Content | Request successful with no content returned |

    | 400 | Bad Request | Request was invalid |

    | 401 | Unauthorised | Authorization header is invalid |

    | 403 | Forbidden | Insufficient permissions |

    | 404 | Not Found | Resource does not exist |

    | 429 | Too Many Requests | Rate Limited |

    | 500s | Internal Server Error | Something went wrong with the Goodstack API |


    # Enum Values


    Generally enum fields in our API are open-ended. New values may be added to an enum and this is not considered a breaking change. ## Integrating safely


    If your code handles enum values exhaustively — for example, a switch without a default case, or deserialisation into a strict typed enum — an unrecognised value may cause errors. We recommend adding a fallback handler for unknown enum values, so that any new value that does reach your integration degrades gracefully rather than failing.'
servers:
- url: https://api.goodstack.io
  description: Production server
- url: https://sandbox-api.goodstack.io
  description: Sandbox server
tags:
- name: Eligibility Subscriptions
paths:
  /v1/eligibility-subscriptions:
    get:
      security:
      - SecretApiKey: []
      summary: List Eligibility Subscriptions
      tags:
      - Eligibility Subscriptions
      parameters:
      - in: query
        name: sort
        schema:
          type: string
          enum:
          - id
        description: Field to sort
      - in: query
        name: query
        schema:
          type: string
          example: Example organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          description: Organisation ID
      - in: query
        name: status
        schema:
          type: string
          enum:
          - pending_validation_request
          - validation_request_failed
          - pending
          - live
          - cancelled
          - cannot_define_eligibility
      - in: query
        name: startDate
        schema:
          type: string
          format: date-time
        description: Start date to retrieve monitoring from.
        example: '2020-10-13T17:46:54.000Z'
      - in: query
        name: endDate
        schema:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
      - in: query
        name: hasOrganisation
        description: Filter eligibility subscriptions based on whether there is a recognised Organisation tied to the subscription
        schema:
          type: boolean
          example: true
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/direction'
      responses:
        '200':
          description: Successfully retrieved a page of Eligibility Subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EligibilitySubscription'
                  object:
                    type: string
                    example: eligibility_subscription
                  totalResults:
                    type: integer
                    example: 33
                  pageSize:
                    type: integer
                    example: 25
                  _links:
                    $ref: '#/components/schemas/CursorLinks'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                IncorrectParams:
                  $ref: '#/components/examples/IncorrectParams'
                CursorError:
                  $ref: '#/components/examples/Pagination.CursorError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
      operationId: getV1EligibilitySubscriptions
      x-operation-id-source: derived
    post:
      security:
      - SecretApiKey: []
      summary: Create an Eligibility Subscription
      tags:
      - Eligibility Subscriptions
      parameters:
      - in: header
        name: Idempotency-Key
        schema:
          type: string
        required: false
        description: Idempotency key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  organisationId:
                    type: string
                  suggestedActivitySubTags:
                    type:
                    - array
                    - 'null'
                    items:
                      type: string
                      example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                required:
                - organisationId
              - type: object
                properties:
                  validationRequestId:
                    type: string
                  suggestedActivitySubTags:
                    type:
                    - array
                    - 'null'
                    items:
                      type: string
                      example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                required:
                - validationRequestId
      responses:
        '200':
          description: Successfully created a Eligibility Subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EligibilitySubscription'
                  object:
                    type: string
                    example: eligibility_subscription
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                EntityNotFound:
                  $ref: '#/components/examples/EligibilitySubscription.EntityNotFound'
                OrganisationNotActive:
                  $ref: '#/components/examples/EligibilitySubscription.OrganisationNotActive'
                InvalidSubTags:
                  $ref: '#/components/examples/EligibilitySubscription.InvalidSubTags'
                BadRequest:
                  $ref: '#/components/examples/BadRequest'
                IncorrectParams:
                  $ref: '#/components/examples/IncorrectParams'
                OriginalCallInProgress:
                  $ref: '#/components/examples/Idempotency.OriginalCallInProgress'
                SameKeyDifferentData:
                  $ref: '#/components/examples/Idempotency.SameKeyDifferentData'
                KeyInUse:
                  $ref: '#/components/examples/Idempotency.KeyInUse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
      operationId: postV1EligibilitySubscriptions
      x-operation-id-source: derived
  /v1/eligibility-subscriptions/{id}:
    parameters:
    - in: path
      name: id
      schema:
        type: string
      required: true
      description: Id of the Eligibility Subscription.
    get:
      security:
      - SecretApiKey: []
      summary: Retrieve an single Eligibility Subscription
      tags:
      - Eligibility Subscriptions
      responses:
        '200':
          description: Successfully retrieved an Eligibility Subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EligibilitySubscription'
                  object:
                    type: string
                    example: eligibility_subscription
        '400':
          $ref: '#/components/responses/IncorrectParams'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: getV1EligibilitySubscriptionsById
      x-operation-id-source: derived
    patch:
      security:
      - SecretApiKey: []
      summary: Edit an Eligibility Subscription
      description: Update an Eligibility Subscription's metadata.
      tags:
      - Eligibility Subscriptions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  description: Metadata object that will be merged with current metadata object.
                  type: object
                  maxProperties: 20
                  additionalProperties:
                    description: Max key size is 40 characters. If key matches already existing key, it will override old value
                    type: string
                    maxLength: 250
      responses:
        '200':
          description: Successfully updates Eligibility Subscription's metadata
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EligibilitySubscription'
                  object:
                    type: string
                    example: eligibility_subscription
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                InvalidMetadata:
                  $ref: '#/components/examples/EligibilitySubscription.InvalidMetadata'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: patchV1EligibilitySubscriptionsById
      x-operation-id-source: derived
  /v1/eligibility-subscriptions/{id}/cancel:
    parameters:
    - in: path
      name: id
      schema:
        type: string
      required: true
      description: Id of the Eligibility Subscription.
    post:
      security:
      - SecretApiKey: []
      summary: Cancel an Eligibility Subscription
      tags:
      - Eligibility Subscriptions
      responses:
        '200':
          description: Successfully cancel an Eligibility Subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/EligibilitySubscription'
                  object:
                    type: string
                    example: eligibility_subscription
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                EligibilitySubscriptionAlreadyCancelled:
                  $ref: '#/components/examples/EligibilitySubscription.EligibilitySubscriptionAlreadyCancelled'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '404':
          $ref: '#/components/responses/NotFound'
      operationId: postV1EligibilitySubscriptionsByIdCancel
      x-operation-id-source: derived
components:
  schemas:
    EligibilitySubscriptionResults:
      type: object
      properties:
        eligibilityStatus:
          type:
          - string
          - 'null'
          enum:
          - pass
          - fail
          example: fail
        confirmedActivitySubTags:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ActivitySubTagWithTag'
        rejectedActivitySubTags:
          description: Confirmed organisation's activity subtags that are not allowed in partner's configuration
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ActivitySubTagWithTag'
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            title:
              type: string
            message:
              type: string
            reasons:
              type:
              - array
              - 'null'
              items:
                type: string
    EligibilitySubscription:
      type: object
      properties:
        id:
          type: string
          example: eligibilitysubscription_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        organisationId:
          type:
          - string
          - 'null'
          example: organisation_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        organisationName:
          type:
          - string
          - 'null'
        partnerId:
          type: string
        configurationId:
          type: string
        validationRequestId:
          type:
          - string
          - 'null'
          example: validationrequest_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        suggestedActivitySubTags:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ActivitySubTagWithTag'
        status:
          type: string
          example: live
          enum:
          - live
          - pending_validation_request
          - validation_request_failed
          - pending
          - cancelled
          - cannot_define_eligibility
        results:
          $ref: '#/components/schemas/EligibilitySubscriptionResults'
        createdAt:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
    ActivitySubTagWithTag:
      type: object
      properties:
        id:
          type: string
          example: activitysubtag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        name:
          type: string
          example: Sport school
          description: SubTag name
        tag:
          $ref: '#/components/schemas/ActivityTagWithoutSubTags'
        description:
          type:
          - string
          - 'null'
          description: SubTag description
        createdAt:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
        deprecatedAt:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
    CursorLinks:
      type: object
      properties:
        current:
          type: string
          example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
        next:
          type: string
          example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
        prev:
          type: string
          example: https://.../v1/...?cursor=eyJ2Ijox...N3AifQ%3D%3D
    ActivityTagWithoutSubTags:
      type: object
      properties:
        id:
          type: string
          example: activitytag_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        name:
          type: string
          example: Education
          description: Tag name
        slug:
          type: string
          example: education
          description: URL-friendly identifier
        description:
          type:
          - string
          - 'null'
          description: Tag description
        createdAt:
          type: string
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
        updatedAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2020-10-13T17:46:54.000Z'
  examples:
    Idempotency.KeyInUse:
      summary: Idempotency - Key in use
      description: Idempotency Key is already in use
      value:
        error:
          code: idempotency/key_already_in_use
          title: Bad request
          message: Idempotency Key is already in use
    BadRequest:
      summary: 400 Bad Request
      description: Bad Request
      value:
        error:
          code: bad_request
          title: Bad request
          message: Something is wrong with your request, please check any parameters and try again
    EligibilitySubscription.EntityNotFound:
      summary: Subscription Entity Not Found
      description: Subscription Entity Not Found
      value:
        error:
          code: eligibility_subscription/entity_not_found
          title: Bad request
          message: Organisation or validation request was not found
    Idempotency.OriginalCallInProgress:
      summary: Idempotency - Original call in progress
      description: Original call with this idempotency key is still in progress, please wait and try again
      value:
        error:
          code: idempotency/original_call_in_progress
          title: Bad request
          message: Original call with this idempotency key is still in progress
    IncorrectParams:
      summary: 400 Incorrect Parameters
      description: Bad Request - Incorrect parameters
      value:
        error:
          code: bad_request
          title: Bad request
          message: One or more of the inputs were invalid
          reasons:
          - pageSize must be greater than or equal to 0
    EligibilitySubscription.EligibilitySubscriptionAlreadyCancelled:
      summary: Eligibility Subscription already cancelled
      description: Eligibility Subscription already cancelled
      value:
        error:
          code: eligibility_subscription/already_cancelled
          title: Bad request
          message: Eligibility Subscription already cancelled
    EligibilitySubscription.InvalidMetadata:
      summary: 400 Bad request
      description: Metadata provided not correct format
      value:
        error:
          title: Bad request
          message: Metadata can only contain from 1 up to 20 keys, with key names up to 50 characters long and values up to 500 characters long
          code: eligibility_subscription/invalid_metadata
    EligibilitySubscription.InvalidSubTags:
      summary: 400 Bad request
      description: At least one of provided suggested subtags is invalid
      value:
        error:
          code: eligibility_subscription/invalid_sub_tags
          title: Bad request
          message: At least one of provided suggested subtags is invalid
    Pagination.CursorError:
      summary: Error in cursor parameter
      description: We were unable to decode the cursor
      value:
        error:
          code: pagination/cursor_error
          title: Bad request
          message: Unable to find the next page
    Idempotency.SameKeyDifferentData:
      summary: Idempotency - Data has changed from previous request
      description: Data has changed from previous request with this key
      value:
        error:
          code: idempotency/same_key_different_data
          title: Bad request
          message: Data has changed from previous request
    EligibilitySubscription.OrganisationNotActive:
      summary: 400 Bad request
      description: Organisation is not active
      value:
        error:
          code: eligibility_subscription/organisation_not_active
          title: Bad request
          message: Organisation is not active
  parameters:
    direction:
      in: query
      name: direction
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
      description: Which way to sort by the given 'sort' field.  Default DESC
    pageSize:
      in: query
      name: pageSize
      required: false
      schema:
        type: integer
        minimum: 0
        default: 25
      description: How many items per page, for pagination.
    cursor:
      in: query
      name: cursor
      required: false
      schema:
        type: string
        example: eyJ2IjoxLCJkIjoibmV4dCIsImlkIjoiZG9uYXRpb25fMDAwMDAwQnc3U1BhMHBxOHBRMFFsckVaWGFaN3AifQ%3D%3D
      description: A cursor that points to where to start the page
  responses:
    IncorrectParams:
      description: Error validating inputs
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    example: bad_request
                  title:
                    type: string
                    example: Bad request
                  message:
                    type: string
                    example: One or more of the inputs were invalid
                  reasons:
                    type: array
                    items:
                      type: string
                      example: pageSize must be greater than or equal to 0
    ForbiddenScope:
      description: Forbidden (scope)
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    example: forbidden
                  title:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: Access is denied due to missing scope permissions
    NotFound:
      description: The specified resource was not found
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    example: not_found
                  title:
                    type: string
                    example: Resource not found
                  message:
                    type: string
                    example: This endpoint is unavailable or can not be found
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    example: unauthorized
                  title:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Access is denied due to invalid credentials
  securitySchemes:
    PublishableApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: API key starting with 'pk_' that can be made public
    SecretApiKey:
      type: apiKey
      in: header
      description: API key starting with 'sk_' that must be kept secure
      name: Authorization
    DonationSessionToken:
      type: apiKey
      in: header
      name: donation-session-token
      description: Donation session token
    SCIMBearer:
      type: http
      scheme: bearer
      description: 'SCIM API key issued for the partner, presented as a bearer token in the

        `Authorization` header. The key is bound to a single partner and the

        partner must have the `scim_api` scope enabled. A missing or invalid key

        returns `401`; a valid key for a partner without the scope also returns

        `401` (`detail: "scim feature not enabled for this partner"`).

        '
x-tagGroups:
- name: NONPROFIT DATA
  tags:
  - Organisations
  - Countries
  - Registries
  - Categories
  - Organisation Branding
- name: NONPROFIT VALIDATIONS
  tags:
  - Validation Requests
  - Validation Request Documents
  - Validation Invites
  - Validation Submissions
  - Validation Submission Documents
  - Validation Submission Configuration
  - Monitoring Subscriptions
  - Eligibility Subscriptions
  - Activities
  - Agent Verifications
- name: MONETARY DONATIONS
  tags:
  - Donations
  - Donation Sessions
  - Users
  - Gift Aid
  - Monetary Donation Verifications
- name: WORKPLACE GIVING
  tags:
  - Employees
  - Giving Donations
  - Donation Match Request
  - Fundraising
  - Volunteering
  - Gamification
  - Campaigns
  - Budgets
  - Donation Wallets
- name: WEBHOOK SUBSCRIPTIONS
  tags:
  - Webhook Subscriptions
- name: WEBHOOK EVENTS
  tags:
  - Agent Verification Events
  - Country Compliance Check Events
  - Donation Events
  - Eligibility Subscription Events
  - Monitoring Subscription Events
  - Validation Request Events
  - Validation Submission Events
  - Monetary Donation Verification Events
x-provenance:
  method: harvested
  publisher: Goodstack
  source: https://reference.poweredbypercent.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)