Skip to content

Commit 554df1b

Browse files
stainless-app[bot]stainless-bot
authored andcommitted
chore(docs): updates price intervals docs (#12)
1 parent 73d5e94 commit 554df1b

5 files changed

Lines changed: 53 additions & 1 deletion

File tree

.stats.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
configured_endpoints: 90
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-2ec02cbf3446827f8bbc949216aec29ff745d79c39f1aa1b7ce2289eab0f338f.yml
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb-75733a914692b0abe72ba99d622fc55b20da1c7fa7f73e2bfee30dfe32b66a51.yml

orb-java-core/src/main/kotlin/com/withorb/api/services/async/SubscriptionServiceAsync.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,19 @@ interface SubscriptionServiceAsync {
744744
* Additionally, a discount, minimum, or maximum can be specified on the price interval. This
745745
* will only apply to this price interval, not any other price intervals on the subscription.
746746
*
747+
* ## Adjustment intervals
748+
*
749+
* An adjustment interval represents the time period that a particular adjustment (a discount,
750+
* minimum, or maximum) applies to the prices on a subscription. Adjustment intervals can be
751+
* added to a subscription by specifying them in the `add_adjustments` array, or modified via
752+
* the `edit_adjustments` array. When creating an adjustment interval, you'll need to provide
753+
* the definition of the new adjustment (the type of adjustment, and which prices it applies
754+
* to), as well as the start and end dates for the adjustment interval. The start and end dates
755+
* of an existing adjustment interval can be edited via the `edit_adjustments` field (just like
756+
* price intervals). (To "change" the amount of a discount, minimum, or maximum, then, you'll
757+
* need to end the existing interval, and create a new adjustment interval with the new amount
758+
* and a start date that matches the end date of the previous interval.)
759+
*
747760
* ## Editing price intervals
748761
*
749762
* Price intervals can be adjusted by specifying edits to make in the `edit` array. A

orb-java-core/src/main/kotlin/com/withorb/api/services/async/SubscriptionServiceAsyncImpl.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -943,6 +943,19 @@ constructor(
943943
* Additionally, a discount, minimum, or maximum can be specified on the price interval. This
944944
* will only apply to this price interval, not any other price intervals on the subscription.
945945
*
946+
* ## Adjustment intervals
947+
*
948+
* An adjustment interval represents the time period that a particular adjustment (a discount,
949+
* minimum, or maximum) applies to the prices on a subscription. Adjustment intervals can be
950+
* added to a subscription by specifying them in the `add_adjustments` array, or modified via
951+
* the `edit_adjustments` array. When creating an adjustment interval, you'll need to provide
952+
* the definition of the new adjustment (the type of adjustment, and which prices it applies
953+
* to), as well as the start and end dates for the adjustment interval. The start and end dates
954+
* of an existing adjustment interval can be edited via the `edit_adjustments` field (just like
955+
* price intervals). (To "change" the amount of a discount, minimum, or maximum, then, you'll
956+
* need to end the existing interval, and create a new adjustment interval with the new amount
957+
* and a start date that matches the end date of the previous interval.)
958+
*
946959
* ## Editing price intervals
947960
*
948961
* Price intervals can be adjusted by specifying edits to make in the `edit` array. A

orb-java-core/src/main/kotlin/com/withorb/api/services/blocking/SubscriptionService.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -743,6 +743,19 @@ interface SubscriptionService {
743743
* Additionally, a discount, minimum, or maximum can be specified on the price interval. This
744744
* will only apply to this price interval, not any other price intervals on the subscription.
745745
*
746+
* ## Adjustment intervals
747+
*
748+
* An adjustment interval represents the time period that a particular adjustment (a discount,
749+
* minimum, or maximum) applies to the prices on a subscription. Adjustment intervals can be
750+
* added to a subscription by specifying them in the `add_adjustments` array, or modified via
751+
* the `edit_adjustments` array. When creating an adjustment interval, you'll need to provide
752+
* the definition of the new adjustment (the type of adjustment, and which prices it applies
753+
* to), as well as the start and end dates for the adjustment interval. The start and end dates
754+
* of an existing adjustment interval can be edited via the `edit_adjustments` field (just like
755+
* price intervals). (To "change" the amount of a discount, minimum, or maximum, then, you'll
756+
* need to end the existing interval, and create a new adjustment interval with the new amount
757+
* and a start date that matches the end date of the previous interval.)
758+
*
746759
* ## Editing price intervals
747760
*
748761
* Price intervals can be adjusted by specifying edits to make in the `edit` array. A

orb-java-core/src/main/kotlin/com/withorb/api/services/blocking/SubscriptionServiceImpl.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -934,6 +934,19 @@ constructor(
934934
* Additionally, a discount, minimum, or maximum can be specified on the price interval. This
935935
* will only apply to this price interval, not any other price intervals on the subscription.
936936
*
937+
* ## Adjustment intervals
938+
*
939+
* An adjustment interval represents the time period that a particular adjustment (a discount,
940+
* minimum, or maximum) applies to the prices on a subscription. Adjustment intervals can be
941+
* added to a subscription by specifying them in the `add_adjustments` array, or modified via
942+
* the `edit_adjustments` array. When creating an adjustment interval, you'll need to provide
943+
* the definition of the new adjustment (the type of adjustment, and which prices it applies
944+
* to), as well as the start and end dates for the adjustment interval. The start and end dates
945+
* of an existing adjustment interval can be edited via the `edit_adjustments` field (just like
946+
* price intervals). (To "change" the amount of a discount, minimum, or maximum, then, you'll
947+
* need to end the existing interval, and create a new adjustment interval with the new amount
948+
* and a start date that matches the end date of the previous interval.)
949+
*
937950
* ## Editing price intervals
938951
*
939952
* Price intervals can be adjusted by specifying edits to make in the `edit` array. A

0 commit comments

Comments
 (0)