Skip to content

Commit 2744f29

Browse files
authored
Merge pull request #459 from bbiggerr/add-payment-methods-endpoint
Add GET /account/payment-methods
2 parents 923700f + 8b54f48 commit 2744f29

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

openapi.yaml

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,6 +1644,102 @@ paths:
16441644
-X PUT \
16451645
--data-binary "/path/to/image"
16461646
https://api.linode.com/v4/account/oauth-clients/edc6790ea9db4d224c5c/thumbnail
1647+
/account/payment-methods:
1648+
x-linode-cli-command: account
1649+
get:
1650+
servers:
1651+
- url: https://api.linode.com/v4beta
1652+
parameters:
1653+
- $ref: '#/components/parameters/pageOffset'
1654+
- $ref: '#/components/parameters/pageSize'
1655+
x-linode-grant: read_only
1656+
tags:
1657+
- Account
1658+
summary: Payment Methods List
1659+
description: |
1660+
Returns a paginated list of Payment Methods for this Account.
1661+
1662+
This endpoint is currently in **beta**. Please make sure to prepend all requests with
1663+
`/v4beta` instead of `/v4`, and be aware that this endpoint may receive breaking
1664+
updates in the future. This notice will be removed when this endpoint is out of
1665+
beta.
1666+
operationId: getPaymentMethods
1667+
x-linode-cli-action: payment-methods-list
1668+
security:
1669+
- personalAccessToken: []
1670+
- oauth:
1671+
- account:read_only
1672+
responses:
1673+
'200':
1674+
description: Returns a paginated list of Payment Method objects.
1675+
content:
1676+
application/json:
1677+
schema:
1678+
type: object
1679+
properties:
1680+
data:
1681+
type: array
1682+
items:
1683+
type: object
1684+
description: Payment Method object response.
1685+
properties:
1686+
method:
1687+
type: string
1688+
description: The type of Payment Method.
1689+
example: 'credit_card'
1690+
x-linode-cli-display: 1
1691+
is_default:
1692+
type: integer
1693+
description: |
1694+
Whether this Payment Method is the default method for automatically processing service charges.
1695+
1696+
`0`: False
1697+
1698+
`1`: True
1699+
example: 1
1700+
x-linode-cli-display: 2
1701+
created:
1702+
type: string
1703+
readOnly: true
1704+
format: date-time
1705+
description: When the Payment Method was added to the Account.
1706+
example: '2018-01-15T00:01:01'
1707+
data:
1708+
type: object
1709+
description: Credit card information.
1710+
properties:
1711+
card_type:
1712+
type: string
1713+
description: The type of credit card.
1714+
example: ""
1715+
x-linode-cli-display: 8
1716+
last_four:
1717+
type: string
1718+
description: The last four digits of the credit card number.
1719+
example: "1234"
1720+
x-linode-cli-display: 9
1721+
expiry:
1722+
type: string
1723+
format: MM/YYYY
1724+
description: The expiration month and year of the credit card.
1725+
example: 06/2022
1726+
x-linode-cli-display: 10
1727+
page:
1728+
$ref: '#/components/schemas/PaginationEnvelope/properties/page'
1729+
pages:
1730+
$ref: '#/components/schemas/PaginationEnvelope/properties/pages'
1731+
results:
1732+
$ref: '#/components/schemas/PaginationEnvelope/properties/results'
1733+
default:
1734+
$ref: '#/components/responses/ErrorResponse'
1735+
x-code-samples:
1736+
- lang: Shell
1737+
source: >
1738+
curl -H "Authorization: Bearer $TOKEN" \
1739+
https://api.linode.com/v4beta/account/payment-methods
1740+
- lang: CLI
1741+
source: >
1742+
linode-cli account payment-methods-list
16471743
/account/payments:
16481744
x-linode-cli-command: account
16491745
get:

0 commit comments

Comments
 (0)