You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rc/api/examples/manage-subscriptions.md
+21-21Lines changed: 21 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ The Redis Cloud REST API lets you create and manage all kinds of subscriptions.
15
15
16
16
### Create an Essentials subscription
17
17
18
-
Use `POST /v1/fixed/subscriptions` to create an Essentials subscription.
18
+
Use [`POST /v1/fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/createSubscription_1" >}}) to create an Essentials subscription.
19
19
20
20
```sh
21
21
POST "https://[host]/v1/fixed/subscriptions"
@@ -30,27 +30,27 @@ Modify the following parameters in the sample JSON document to create a subscrip
30
30
31
31
-**`paymentMethodId`** - Specify a payment method connected to your account.
32
32
33
-
Use `GET /v1/payment-methods` to find a payment method ID.
33
+
Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID.
34
34
35
35
You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration.
36
36
37
37
-**`planId`** - Specify an essentials plan to create.
38
38
39
-
Use `GET /v1/fixed/plans` to get a list of plan IDs.
39
+
Use [`GET /v1/fixed/plans`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans" >}}) to get a list of plan IDs.
40
40
41
-
After you create an Essentials subscription, you must use the `POST /v1/fixed/subscriptions/{subscriptionId}/databases` endpoint to create the database.
41
+
After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to create the database.
42
42
43
-
You can include the contents of the JSON document in the `POST /subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface]({{< relref "/operate/rc/api/get-started/use-rest-api#swagger-user-interface" >}}) for more details.
43
+
You can include the contents of the JSON document in the `POST /v1/fixed/subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface]({{< relref "/operate/rc/api/get-started/use-rest-api#swagger-user-interface" >}}) for more details.
44
44
45
45
{{< note >}}
46
46
The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You can reference these examples and modify them to fit your specific needs and account settings. The examples will fail if used as-is.
47
47
{{< /note >}}
48
48
49
-
The response body contains the `taskId` for the task that creates the subscription. You can use `GET /v1/tasks/{taskId}` to track the task's status.
49
+
The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
50
50
51
51
### Update an Essentials subscription
52
52
53
-
Use `PUT /v1/fixed/subscriptions/{subscriptionId}` to update an Essentials subscription.
53
+
Use [`PUT /v1/fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to update an Essentials subscription.
54
54
55
55
```sh
56
56
PUT "https://[host]/v1/fixed/subscriptions/{subscriptionId}"
@@ -66,32 +66,32 @@ You can only change the following settings with this endpoint:
66
66
67
67
-**`planId`** - Specify a new Essentials plan to change to.
68
68
69
-
Use `GET /v1/fixed/plans` to get a list of plan IDs.
69
+
Use [`GET /v1/fixed/plans`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans" >}}) to get a list of plan IDs.
70
70
71
71
You can only change to a plan that:
72
72
- Is in the same cloud provider and region of your current plan.
73
73
- Has a compatible [High-availability option]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) to your current plan. For example, if your current plan has single-zone replication, you cannot switch to a plan with multi-zone replication, but you can switch to a plan with no replication. If your current plan has multi-zone replication, you must switch to a plan with multi-zone replication.
74
74
75
75
-**`paymentMethodId`** - Specify a different payment method connected to your account.
76
76
77
-
Use `GET /v1/payment-methods` to find a payment method ID.
77
+
Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID.
78
78
79
-
The response body contains the `taskId` for the task that updates the subscription. You can use `GET /v1/tasks/{taskId}` to track the task's status.
79
+
The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
80
80
81
81
### Delete an Essentials subscription
82
82
83
-
Use `DELETE /v1/subscriptions/<subscriptionId>` to delete a subscription.
83
+
Use [`DELETE /v1/fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to delete a subscription.
The response body contains the `taskId` for the task that deletes the subscription. You can use `GET /v1/tasks/<taskId>` to track the task's status.
88
+
The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
89
89
90
90
## Redis Cloud Pro
91
91
92
92
### Create a Pro subscription
93
93
94
-
Use `POST /v1/subscriptions` to create a Pro subscription.
94
+
Use [`POST /v1/subscriptions`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to create a Pro subscription.
95
95
96
96
```sh
97
97
POST "https://[host]/v1/subscriptions"
@@ -124,13 +124,13 @@ Modify the following parameters in the sample JSON document to create a subscrip
124
124
125
125
-**`paymentMethodId`** - Specify a payment method connected to your account.
126
126
127
-
Use `GET /v1/payment-methods` to find a payment method ID.
127
+
Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID.
128
128
129
129
You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration.
130
130
131
131
-**`cloudAccountId`** - Set a cloud account ID connected to your account.
132
132
133
-
To list cloud account IDs, use `GET /v1/cloud-accounts`.
133
+
To list cloud account IDs, use [`GET /v1/cloud-accounts`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}).
134
134
135
135
You don't need to pass this field in your API request if you want to use internal resources.
136
136
@@ -142,11 +142,11 @@ You can include the contents of the JSON document in the `POST /subscriptions` o
142
142
The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You can reference these examples and modify them to fit your specific needs and account settings. The examples will fail if used as-is.
143
143
{{< /note >}}
144
144
145
-
The response body contains the `taskId` for the task that creates the subscription. You can use `GET /v1/tasks/{taskId}` to track the task's status.
145
+
The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
146
146
147
147
### Update a Pro subscription
148
148
149
-
Use `PUT /v1/subscriptions/{subscriptionId}` to update a Pro subscription.
149
+
Use [`PUT /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to update a Pro subscription.
150
150
151
151
```sh
152
152
PUT "https://[host]/v1/subscriptions/{subscriptionId}"
@@ -161,15 +161,15 @@ You can only change the following settings with this endpoint:
161
161
162
162
-**`paymentMethodId`** - Specify a different payment method connected to your account.
163
163
164
-
Use `GET /v1/payment-methods` to find a payment method ID.
164
+
Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID.
165
165
166
-
The response body contains the `taskId` for the task that updates the subscription. You can use `GET /v1/tasks/{taskId}` to track the task's status.
166
+
The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
167
167
168
168
### Delete a Pro subscription
169
169
170
-
Use `DELETE /v1/subscriptions/{subscriptionId}` to delete a subscription.
170
+
Use [`DELETE /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#ADD-TAG" >}}) to delete a subscription.
The response body contains the `taskId` for the task that deletes the subscription. You can use `GET /v1/tasks/{taskId}` to track the task's status.
175
+
The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status.
0 commit comments