Skip to content

Commit 1e98a86

Browse files
noon-dawgnoon-dawg
authored
Add detail to create order fields (#1705)
1 parent dd1b477 commit 1e98a86

17 files changed

+58
-11
lines changed

‎openapi/components/schemas/FlexiblePlan.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
allOf:
22
- type: object
3+
description: |-
4+
Customize an existing plan for the current order.
5+
6+
To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan).
37
required:
48
- id
59
properties:

‎openapi/components/schemas/OneTimeOrder.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ properties:
8181
maxLength: 50
8282
example: in_0YVF9605RKC62BP14NE2R7V2XT
8383
items:
84-
description: Item details.
84+
description: Details of items in the order.
8585
type: array
8686
minItems: 1
8787
items:

‎openapi/components/schemas/OneTimeSalePlan.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
type: object
2+
description: Details of the one-time sale plan. Use this plan for non-recurring, one-time, sales.
23
required:
34
- name
45
- currency

‎openapi/components/schemas/OrderItem.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ properties:
1919
description: Number of product units in the specified plan.
2020
type: integer
2121
plan:
22-
description: Plan details.
22+
description: Details of the plan.
2323
anyOf:
2424
- $ref: ./OriginalPlan.yaml
2525
- $ref: ./FlexiblePlan.yaml

‎openapi/components/schemas/OriginalPlan.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
type: object
2-
description: Plan without changes.
2+
description: |-
3+
Use an existing plan without changes for the current order.
4+
5+
To create a new plan, see [Create a plan](https://all-rebilly.redoc.ly/tag/Plans/operation/PostPlan).
36
required:
47
- id
58
properties:

‎openapi/components/schemas/PlanFormulaFixedFee.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
title: Fixed-fee
2+
description: |-
3+
Fixed-fee pricing details.
4+
Use this formula for subscriptions that involve the same price,
5+
number of units, and reoccur over a fixed period of time.
6+
7+
For more information, see [Fixed-fee per period](https://www.rebilly.com/docs/settings/pricing-formulas/#fixed-fee-per-period).
18
type: object
29
required:
310
- price

‎openapi/components/schemas/PlanFormulaFlatRate.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
title: Flat rate
2+
description: |-
3+
Flat rate pricing details.
4+
Use this formula to charge a flat fee per unit.
5+
For example, $0.10 per transaction or $4 per unit.
6+
7+
For more information, see [Flat rate pricing](https://www.rebilly.com/docs/billing/pricing-formulas/#flat-rate-pricing).
18
type: object
29
required:
310
- price

‎openapi/components/schemas/PlanFormulaStairstep.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
title: Stair-step
2+
description: |-
3+
Stair-step pricing details.
4+
Use this formula to charge for units that are sold in specific quantities.
5+
6+
For more information, see [Stair-step](https://www.rebilly.com/docs/billing/pricing-formulas/#stair-step).
17
type: object
28
required:
39
- brackets

‎openapi/components/schemas/PlanFormulaTiered.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
title: Tiered
2+
description: |-
3+
Tiered pricing details.
4+
Use this formula to charge for units that are sold within defined quantity ranges, or tiers.
5+
6+
For more information, see [Tiered](https://www.rebilly.com/docs/settings/pricing-formulas/#tiered).
17
type: object
28
required:
39
- brackets

‎openapi/components/schemas/PlanFormulaVolume.yaml

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
title: Volume
2+
description: |-
3+
Volume pricing details.
4+
Use this formula to charge for units that are sold in bulk,
5+
or volume ranges. In general,
6+
this formula means that a customer pays less per unit when they buy a large volume of units.
7+
8+
For more information, see [Volume](https://www.rebilly.com/docs/settings/pricing-formulas/#volume).
19
type: object
210
required:
311
- brackets

‎openapi/components/schemas/PlanPriceFormula.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1+
description: Pricing details.
12
type: object
2-
description: Pricing information.
33
discriminator:
44
propertyName: formula
55
mapping:

‎openapi/components/schemas/StorefrontOneTimeOrder.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ properties:
5757
maxLength: 50
5858
example: in_0YVF9605RKC62BP14NE2R7V2XT
5959
items:
60-
description: Item details.
60+
description: Details of items in the order.
6161
type: array
6262
minItems: 1
6363
items:

‎openapi/components/schemas/StorefrontSubscriptionOrder.yaml

+3-3
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ properties:
5757
maxLength: 50
5858
example: in_0YVF9605RKC62BP14NE2R7V2XT
5959
items:
60-
description: Item details.
60+
description: Details of items in the order.
6161
type: array
6262
minItems: 1
6363
items:
@@ -191,7 +191,7 @@ properties:
191191
- $ref: ./InvoiceTimeShift.yaml
192192
- type: 'null'
193193
recurringInterval:
194-
type:
194+
type:
195195
- 'object'
196196
- 'null'
197197
description: |-
@@ -252,7 +252,7 @@ properties:
252252
- $ref: ./InvoiceTimeShift.yaml
253253
- type: 'null'
254254
recurringInterval:
255-
type:
255+
type:
256256
- 'object'
257257
- 'null'
258258
description: |-

‎openapi/components/schemas/SubscriptionChange.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ required:
55
- prorated
66
properties:
77
items:
8-
description: Item details.
8+
description: Details of items in the order.
99
type: array
1010
minItems: 1
1111
items:

‎openapi/components/schemas/SubscriptionOrder.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ properties:
124124
- $ref: ./InvoiceTimeShift.yaml
125125
- type: 'null'
126126
recurringInterval:
127-
type:
127+
type:
128128
- 'object'
129129
- 'null'
130130
description: |-
@@ -294,7 +294,7 @@ properties:
294294
maxLength: 50
295295
example: in_0YVF9605RKC62BP14NE2R7V2XT
296296
items:
297-
description: Item details.
297+
description: Details of items in the order.
298298
type: array
299299
minItems: 1
300300
items:

‎openapi/components/schemas/SubscriptionOrderPlan.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
description: Details of the subscription order plan. Use this plan for subscriptions or sales that reoccur over a period of time.
12
type: object
23
required:
34
- name

‎openapi/components/schemas/TrialOnlyPlan.yaml

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
description: |-
2+
Details of the trial-only plan.
3+
Use this plan for limited-time product trials.
4+
Trials may have a reduced fee, or may be free.
15
type: object
26
required:
37
- name

0 commit comments

Comments
 (0)