Retrieve an account capability | Swagger Petstore

3 parameters

accountstringrequired

The unique identifier of the account that owns the capability.

capabilitystringrequired

The unique identifier of the capability to retrieve.

expandarray<string>optional

Specifies which fields in the response should be expanded.

2 status codes

200Returns the capability object with its status, requirements, and future requirements.

accountstringrequired

The account for which the capability enables functionality.

future_requirementsobjectoptional

idstringrequired

The identifier for the capability.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:capability

requestedbooleanrequired

Whether the capability has been requested.

requested_atintegeroptional

Time at which the capability was requested. Measured in seconds since the Unix epoch.

requirementsobjectoptional

statusstringrequired

The status of the capability.

Allowed:activeinactivependingunrequested

defaultError response.

errorobjectrequired

Error handling

account and capability must identify an existing capability belonging to the specified account.

import { Stripe } from "swagger-petstore---openapi-3-0-sdk";

const client = new Stripe({
  baseUrl: "https://api.stripe.com/",
  auth: { basicAuth: { username: process.env.STRIPE_USERNAME!, password: process.env.STRIPE_PASSWORD! } },
});

const result = await client.accounts.getAccountCapabilitiesCapability({
  account: "example",
  capability: "example",
});

{
  "account": 42,
  "future_requirements": {
    "alternatives": [
      {
        "alternative_fields_due": [
          "example_value"
        ],
        "original_fields_due": [
          "example_value"
        ]
      }
    ],
    "current_deadline": 1,
    "currently_due": [
      "example_value"
    ],
    "disabled_reason": "other",
    "errors": [
      {
        "code": "external_request",
        "reason": "example_value",
        "requirement": "example_value"
      }
    ],
    "eventually_due": [
      "example_value"
    ],
    "past_due": [
      "example_value"
    ],
    "pending_verification": [
      "example_value"
    ]
  },
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "capability",
  "requested": true,
  "requested_at": 1,
  "requirements": {
    "alternatives": [
      {
        "alternative_fields_due": [
          "example_value"
        ],
        "original_fields_due": [
          "example_value"
        ]
      }
    ],
    "current_deadline": 1,
    "currently_due": [
      "example_value"
    ],
    "disabled_reason": "other",
    "errors": [
      {
        "code": "external_request",
        "reason": "example_value",
        "requirement": "example_value"
      }
    ],
    "eventually_due": [
      "example_value"
    ],
    "past_due": [
      "example_value"
    ],
    "pending_verification": [
      "example_value"
    ]
  },
  "status": "active"
}

Request

Response

Errors