Skip to content

Commit

Permalink
chore(docs): updates price intervals docs (#302)
Browse files Browse the repository at this point in the history
  • Loading branch information
stainless-app[bot] authored Jun 27, 2024
1 parent 1e0c4de commit 8cd2981
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
configured_endpoints: 90
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-2ec02cbf3446827f8bbc949216aec29ff745d79c39f1aa1b7ce2289eab0f338f.yml
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-75733a914692b0abe72ba99d622fc55b20da1c7fa7f73e2bfee30dfe32b66a51.yml
30 changes: 30 additions & 0 deletions src/orb/resources/subscriptions.py
Original file line number Diff line number Diff line change
Expand Up @@ -1286,6 +1286,21 @@ def price_intervals(
interval. This will only apply to this price interval, not any other price
intervals on the subscription.
## Adjustment intervals
An adjustment interval represents the time period that a particular adjustment
(a discount, minimum, or maximum) applies to the prices on a subscription.
Adjustment intervals can be added to a subscription by specifying them in the
`add_adjustments` array, or modified via the `edit_adjustments` array. When
creating an adjustment interval, you'll need to provide the definition of the
new adjustment (the type of adjustment, and which prices it applies to), as well
as the start and end dates for the adjustment interval. The start and end dates
of an existing adjustment interval can be edited via the `edit_adjustments`
field (just like price intervals). (To "change" the amount of a discount,
minimum, or maximum, then, you'll need to end the existing interval, and create
a new adjustment interval with the new amount and a start date that matches the
end date of the previous interval.)
## Editing price intervals
Price intervals can be adjusted by specifying edits to make in the `edit` array.
Expand Down Expand Up @@ -3006,6 +3021,21 @@ async def price_intervals(
interval. This will only apply to this price interval, not any other price
intervals on the subscription.
## Adjustment intervals
An adjustment interval represents the time period that a particular adjustment
(a discount, minimum, or maximum) applies to the prices on a subscription.
Adjustment intervals can be added to a subscription by specifying them in the
`add_adjustments` array, or modified via the `edit_adjustments` array. When
creating an adjustment interval, you'll need to provide the definition of the
new adjustment (the type of adjustment, and which prices it applies to), as well
as the start and end dates for the adjustment interval. The start and end dates
of an existing adjustment interval can be edited via the `edit_adjustments`
field (just like price intervals). (To "change" the amount of a discount,
minimum, or maximum, then, you'll need to end the existing interval, and create
a new adjustment interval with the new amount and a start date that matches the
end date of the previous interval.)
## Editing price intervals
Price intervals can be adjusted by specifying edits to make in the `edit` array.
Expand Down

0 comments on commit 8cd2981

Please sign in to comment.