Skip to content

Commit b4516ab

Browse files
committed
Add Payment Method Make Default endpoint
1 parent c4d4796 commit b4516ab

File tree

1 file changed

+47
-5
lines changed

1 file changed

+47
-5
lines changed

openapi.yaml

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1688,7 +1688,8 @@ paths:
16881688
- Account
16891689
summary: Payment Method Add
16901690
description: |
1691-
Adds a Payment Method to your Account with the option to set it as the default method.
1691+
Adds a Payment Method to your Account with the option to set it as the default method. Adding a default
1692+
Payment Method removes the default status from any other Payment Method.
16921693

16931694
Prior to adding a Payment Method, ensure that your billing address information is up-to-date
16941695
with a valid `zip` by using the Account Update ([PUT /account](/docs/api/account/#account-update)) endpoint.
@@ -1768,16 +1769,13 @@ paths:
17681769
get:
17691770
servers:
17701771
- url: https://api.linode.com/v4
1771-
parameters:
1772-
- $ref: '#/components/parameters/pageOffset'
1773-
- $ref: '#/components/parameters/pageSize'
17741772
x-linode-grant: read_only
17751773
tags:
17761774
- Account
17771775
summary: Payment Method View
17781776
description: |
17791777
View the details of the specified Payment Method.
1780-
operationId: getPaymentMethods
1778+
operationId: getPaymentMethod
17811779
x-linode-cli-action: payment-method-view
17821780
security:
17831781
- personalAccessToken: []
@@ -1800,6 +1798,50 @@ paths:
18001798
- lang: CLI
18011799
source: >
18021800
linode-cli account payment-method-view 123
1801+
/account/payment-methods/{paymentMethodId}/make-default:
1802+
x-linode-cli-command: account
1803+
parameters:
1804+
- name: paymentMethodId
1805+
in: path
1806+
description: The ID of the Payment Method to make default.
1807+
required: true
1808+
schema:
1809+
type: integer
1810+
post:
1811+
servers:
1812+
- url: https://api.linode.com/v4
1813+
x-linode-grant: read_write
1814+
tags:
1815+
- Account
1816+
summary: Payment Method Make Default
1817+
description: |
1818+
Make the specified Payment Method the default method for automatically processing payments.
1819+
1820+
Removes the default status from any other Payment Method.
1821+
operationId: makePaymentMethodDefault
1822+
x-linode-cli-action: payment-method-make-default
1823+
security:
1824+
- personalAccessToken: []
1825+
- oauth:
1826+
- account:read_only
1827+
responses:
1828+
'200':
1829+
description: Payment Method successfully set as the default method.
1830+
content:
1831+
application/json:
1832+
schema:
1833+
type: object
1834+
default:
1835+
$ref: '#/components/responses/ErrorResponse'
1836+
x-code-samples:
1837+
- lang: Shell
1838+
source: >
1839+
curl -H "Authorization: Bearer $TOKEN" \
1840+
-X POST \
1841+
https://api.linode.com/v4/account/payment-methods/123/make-default
1842+
- lang: CLI
1843+
source: >
1844+
linode-cli account payment-method-make-default 123
18031845
/account/payments:
18041846
x-linode-cli-command: account
18051847
get:

0 commit comments

Comments
 (0)