Skip to main content
POST
/
subscription_changes
/
{subscription_change_id}
/
apply
Apply subscription change
curl --request POST \
  --url https://api.withorb.com/v1/subscription_changes/{subscription_change_id}/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "previously_collected_amount": "<string>",
  "mark_as_paid": true,
  "description": "<string>",
  "payment_received_date": "2023-12-25",
  "payment_external_id": "<string>",
  "payment_notes": "<string>"
}'
{
  "id": "<string>",
  "status": "pending",
  "applied_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "expiration_time": "2023-11-07T05:31:56Z",
  "subscription": {
    "metadata": {},
    "id": "<string>",
    "customer": {
      "metadata": {},
      "id": "<string>",
      "external_customer_id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "timezone": "<string>",
      "payment_provider_id": "<string>",
      "payment_provider": "quickbooks",
      "created_at": "2023-11-07T05:31:56Z",
      "shipping_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "billing_address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      },
      "balance": "<string>",
      "currency": "<string>",
      "tax_id": {
        "country": "AD",
        "type": "ad_nrt",
        "value": "<string>"
      },
      "auto_collection": true,
      "exempt_from_automated_tax": true,
      "email_delivery": true,
      "auto_issuance": true,
      "additional_emails": [
        "<string>"
      ],
      "portal_url": "<string>",
      "accounting_sync_configuration": {
        "excluded": true,
        "accounting_providers": [
          {
            "provider_type": "quickbooks",
            "external_provider_id": "<string>"
          }
        ]
      },
      "reporting_configuration": {
        "exempt": true
      },
      "hierarchy": {
        "parent": {
          "id": "<string>",
          "external_customer_id": "<string>"
        },
        "children": [
          {
            "id": "<string>",
            "external_customer_id": "<string>"
          }
        ]
      },
      "automatic_tax_enabled": true
    },
    "plan": {
      "metadata": {},
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "maximum_amount": "<string>",
      "minimum_amount": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "active",
      "maximum": {
        "maximum_amount": "<string>",
        "filters": [
          "<any>"
        ],
        "applies_to_price_ids": [
          "<any>"
        ]
      },
      "minimum": {
        "minimum_amount": "<string>",
        "filters": [
          "<any>"
        ],
        "applies_to_price_ids": [
          "<any>"
        ]
      },
      "discount": {
        "discount_type": "percentage",
        "applies_to_price_ids": [
          "h74gfhdjvn7ujokd",
          "7hfgtgjnbvc3ujkl"
        ],
        "filters": [
          {
            "field": "<any>",
            "operator": "<any>",
            "values": "<any>"
          }
        ],
        "reason": "<string>",
        "percentage_discount": 0.15
      },
      "product": {
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>"
      },
      "version": 123,
      "trial_config": {
        "trial_period": 123,
        "trial_period_unit": "days"
      },
      "plan_phases": [
        {
          "id": "<string>",
          "description": "<string>",
          "duration": 123,
          "duration_unit": "daily",
          "name": "<string>",
          "order": 123,
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "maximum_amount": "<string>",
          "minimum_amount": "<string>",
          "discount": {
            "discount_type": "<any>",
            "applies_to_price_ids": "<any>",
            "filters": "<any>",
            "reason": "<any>",
            "percentage_discount": "<any>"
          }
        }
      ],
      "base_plan": {
        "id": "m2t5akQeh2obwxeU",
        "external_plan_id": "m2t5akQeh2obwxeU",
        "name": "Example plan"
      },
      "base_plan_id": "<string>",
      "external_plan_id": "<string>",
      "currency": "<string>",
      "invoicing_currency": "<string>",
      "net_terms": 123,
      "default_invoice_memo": "<string>",
      "prices": [
        {
          "model_type": "unit",
          "unit_config": {
            "unit_amount": "<string>",
            "prorated": true
          },
          "metadata": {},
          "id": "<string>",
          "name": "<string>",
          "external_price_id": "<string>",
          "replaces_price_id": "<string>",
          "price_type": "usage_price",
          "created_at": "2023-11-07T05:31:56Z",
          "cadence": "one_time",
          "billing_mode": "in_advance",
          "billing_cycle_configuration": {
            "duration": 123,
            "duration_unit": "day"
          },
          "invoicing_cycle_configuration": {
            "duration": 123,
            "duration_unit": "day"
          },
          "billable_metric": {
            "id": "<string>"
          },
          "dimensional_price_configuration": {
            "dimensional_price_group_id": "<string>",
            "dimension_values": [
              "<any>"
            ]
          },
          "fixed_price_quantity": 123,
          "plan_phase_order": 123,
          "currency": "<string>",
          "conversion_rate": 123,
          "conversion_rate_config": {
            "conversion_rate_type": "unit",
            "unit_config": {}
          },
          "item": {
            "id": "<string>",
            "name": "<string>"
          },
          "credit_allocation": {
            "currency": "<string>",
            "allows_rollover": true,
            "custom_expiration": {},
            "filters": [
              "<any>"
            ]
          },
          "composite_price_filters": [
            {
              "field": "<any>",
              "operator": "<any>",
              "values": "<any>"
            }
          ],
          "discount": {
            "discount_type": "<any>",
            "applies_to_price_ids": "<any>",
            "filters": "<any>",
            "reason": "<any>",
            "percentage_discount": "<any>"
          },
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "maximum_amount": "<string>"
        }
      ],
      "adjustments": [
        {
          "id": "<string>",
          "is_invoice_level": true,
          "filters": [
            {
              "field": "<any>",
              "operator": "<any>",
              "values": "<any>"
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "replaces_adjustment_id": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "plan_phase_order": 123
        }
      ]
    },
    "name": "<string>",
    "start_date": "2023-11-07T05:31:56Z",
    "end_date": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "current_billing_period_start_date": "2023-11-07T05:31:56Z",
    "current_billing_period_end_date": "2023-11-07T05:31:56Z",
    "status": "active",
    "trial_info": {
      "end_date": "2023-11-07T05:31:56Z"
    },
    "active_plan_phase_order": 123,
    "fixed_fee_quantity_schedule": [
      {
        "price_id": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "quantity": 123
      }
    ],
    "default_invoice_memo": "<string>",
    "auto_collection": true,
    "net_terms": 123,
    "redeemed_coupon": {
      "coupon_id": "<string>",
      "start_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-11-07T05:31:56Z"
    },
    "billing_cycle_day": 16,
    "billing_cycle_anchor_configuration": {
      "day": 16,
      "month": 6,
      "year": 123
    },
    "invoicing_threshold": "<string>",
    "price_intervals": [
      {
        "id": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "price": {
          "model_type": "unit",
          "unit_config": {
            "unit_amount": "<string>",
            "prorated": true
          },
          "metadata": {},
          "id": "<string>",
          "name": "<string>",
          "external_price_id": "<string>",
          "replaces_price_id": "<string>",
          "price_type": "usage_price",
          "created_at": "2023-11-07T05:31:56Z",
          "cadence": "one_time",
          "billing_mode": "in_advance",
          "billing_cycle_configuration": {
            "duration": 123,
            "duration_unit": "day"
          },
          "invoicing_cycle_configuration": {
            "duration": 123,
            "duration_unit": "day"
          },
          "billable_metric": {
            "id": "<string>"
          },
          "dimensional_price_configuration": {
            "dimensional_price_group_id": "<string>",
            "dimension_values": [
              "<any>"
            ]
          },
          "fixed_price_quantity": 123,
          "plan_phase_order": 123,
          "currency": "<string>",
          "conversion_rate": 123,
          "conversion_rate_config": {
            "conversion_rate_type": "unit",
            "unit_config": {}
          },
          "item": {
            "id": "<string>",
            "name": "<string>"
          },
          "credit_allocation": {
            "currency": "<string>",
            "allows_rollover": true,
            "custom_expiration": {},
            "filters": [
              "<any>"
            ]
          },
          "composite_price_filters": [
            {
              "field": "<any>",
              "operator": "<any>",
              "values": "<any>"
            }
          ],
          "discount": {
            "discount_type": "<any>",
            "applies_to_price_ids": "<any>",
            "filters": "<any>",
            "reason": "<any>",
            "percentage_discount": "<any>"
          },
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "maximum_amount": "<string>"
        },
        "billing_cycle_day": 123,
        "can_defer_billing": true,
        "fixed_fee_quantity_transitions": [
          {
            "price_id": "<string>",
            "effective_date": "2023-11-07T05:31:56Z",
            "quantity": 123
          }
        ],
        "current_billing_period_start_date": "2023-11-07T05:31:56Z",
        "current_billing_period_end_date": "2023-11-07T05:31:56Z",
        "filter": "<string>",
        "usage_customer_ids": [
          "<string>"
        ]
      }
    ],
    "adjustment_intervals": [
      {
        "id": "<string>",
        "adjustment": {
          "id": "<string>",
          "is_invoice_level": true,
          "filters": [
            {
              "field": "<any>",
              "operator": "<any>",
              "values": "<any>"
            }
          ],
          "applies_to_price_ids": [
            "<string>"
          ],
          "reason": "<string>",
          "replaces_adjustment_id": "<string>",
          "adjustment_type": "usage_discount",
          "usage_discount": 123,
          "plan_phase_order": 123
        },
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "applies_to_price_interval_ids": [
          "<string>"
        ]
      }
    ],
    "discount_intervals": [
      {
        "discount_type": "amount",
        "amount_discount": "<string>",
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "filters": [
          {
            "field": "<any>",
            "operator": "<any>",
            "values": "<any>"
          }
        ],
        "applies_to_price_interval_ids": [
          "<string>"
        ]
      }
    ],
    "minimum_intervals": [
      {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "filters": [
          {
            "field": "<any>",
            "operator": "<any>",
            "values": "<any>"
          }
        ],
        "applies_to_price_interval_ids": [
          "<string>"
        ],
        "minimum_amount": "<string>"
      }
    ],
    "maximum_intervals": [
      {
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "filters": [
          {
            "field": "<any>",
            "operator": "<any>",
            "values": "<any>"
          }
        ],
        "applies_to_price_interval_ids": [
          "<string>"
        ],
        "maximum_amount": "<string>"
      }
    ],
    "pending_subscription_change": {
      "id": "<string>"
    },
    "changed_resources": {
      "created_credit_notes": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "voided_at": "2023-11-07T05:31:56Z",
          "credit_note_number": "<string>",
          "invoice_id": "<string>",
          "memo": "<string>",
          "reason": "Duplicate",
          "type": "refund",
          "subtotal": "<string>",
          "total": "<string>",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "credit_note_pdf": "<string>",
          "minimum_amount_refunded": "<string>",
          "discounts": [
            {
              "discount_type": "<any>",
              "percentage_discount": "<any>",
              "amount_applied": "<any>",
              "reason": "<any>",
              "applies_to_prices": "<any>"
            }
          ],
          "maximum_amount_adjustment": {
            "discount_type": "percentage",
            "percentage_discount": 123,
            "amount_applied": "<string>",
            "reason": "<string>",
            "applies_to_prices": [
              "<any>"
            ]
          },
          "line_items": [
            {
              "id": "<any>",
              "name": "<any>",
              "subtotal": "<any>",
              "amount": "<any>",
              "quantity": "<any>",
              "discounts": "<any>",
              "tax_amounts": "<any>",
              "item_id": "<any>",
              "start_time_inclusive": "<any>",
              "end_time_exclusive": "<any>"
            }
          ]
        }
      ],
      "voided_credit_notes": [
        {
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "voided_at": "2023-11-07T05:31:56Z",
          "credit_note_number": "<string>",
          "invoice_id": "<string>",
          "memo": "<string>",
          "reason": "Duplicate",
          "type": "refund",
          "subtotal": "<string>",
          "total": "<string>",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "credit_note_pdf": "<string>",
          "minimum_amount_refunded": "<string>",
          "discounts": [
            {
              "discount_type": "<any>",
              "percentage_discount": "<any>",
              "amount_applied": "<any>",
              "reason": "<any>",
              "applies_to_prices": "<any>"
            }
          ],
          "maximum_amount_adjustment": {
            "discount_type": "percentage",
            "percentage_discount": 123,
            "amount_applied": "<string>",
            "reason": "<string>",
            "applies_to_prices": [
              "<any>"
            ]
          },
          "line_items": [
            {
              "id": "<any>",
              "name": "<any>",
              "subtotal": "<any>",
              "amount": "<any>",
              "quantity": "<any>",
              "discounts": "<any>",
              "tax_amounts": "<any>",
              "item_id": "<any>",
              "start_time_inclusive": "<any>",
              "end_time_exclusive": "<any>"
            }
          ]
        }
      ],
      "created_invoices": [
        {
          "metadata": {},
          "voided_at": "2023-11-07T05:31:56Z",
          "paid_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "scheduled_issue_at": "2023-11-07T05:31:56Z",
          "auto_collection": {
            "next_attempt_at": "2023-11-07T05:31:56Z",
            "previously_attempted_at": "2023-11-07T05:31:56Z",
            "enabled": true,
            "num_attempts": 123
          },
          "issue_failed_at": "2023-11-07T05:31:56Z",
          "sync_failed_at": "2023-11-07T05:31:56Z",
          "payment_failed_at": "2023-11-07T05:31:56Z",
          "payment_started_at": "2023-11-07T05:31:56Z",
          "amount_due": "8.00",
          "created_at": "2022-05-01T07:01:31+00:00",
          "currency": "USD",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "due_date": "2022-05-30T07:00:00+00:00",
          "id": "<string>",
          "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
          "invoice_number": "JYEFHK-00001",
          "subscription": {
            "id": "VDGsT23osdLb84KD"
          },
          "total": "8.00",
          "customer_balance_transactions": [
            {
              "id": "cgZa3SXcsPTVyC4Y",
              "created_at": "2022-05-01T07:01:31+00:00",
              "starting_balance": "33.00",
              "ending_balance": "22.00",
              "amount": "11.00",
              "action": "applied_to_invoice",
              "description": "An optional description",
              "invoice": {
                "id": "<any>"
              },
              "type": "increment",
              "credit_note": {
                "id": "<any>"
              }
            }
          ],
          "status": "issued",
          "invoice_source": "subscription",
          "shipping_address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          },
          "billing_address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          },
          "hosted_invoice_url": "<string>",
          "will_auto_issue": true,
          "eligible_to_issue_at": "2023-11-07T05:31:56Z",
          "customer_tax_id": {
            "country": "AD",
            "type": "ad_nrt",
            "value": "<string>"
          },
          "memo": "<string>",
          "credit_notes": [
            {
              "id": "<string>",
              "credit_note_number": "<string>",
              "reason": "<string>",
              "total": "<string>",
              "voided_at": "2022-05-01T07:01:31+00:00",
              "type": "<string>",
              "memo": "<string>"
            }
          ],
          "payment_attempts": [
            {
              "id": "<string>",
              "payment_provider": "stripe",
              "payment_provider_id": "<string>",
              "amount": "<string>",
              "succeeded": true,
              "created_at": "2023-11-07T05:31:56Z",
              "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
            }
          ],
          "discount": "<any>",
          "discounts": [
            {
              "discount_type": "<any>",
              "applies_to_price_ids": "<any>",
              "filters": "<any>",
              "reason": "<any>",
              "percentage_discount": "<any>"
            }
          ],
          "minimum": {
            "minimum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<string>",
            "filters": [
              "<any>"
            ],
            "applies_to_price_ids": [
              "<any>"
            ]
          },
          "maximum_amount": "<string>",
          "line_items": [
            {
              "amount": "7.00",
              "discount": {},
              "end_date": "2022-02-01T08:00:00+00:00",
              "grouping": "<string>",
              "minimum": {
                "minimum_amount": "<any>",
                "filters": "<any>",
                "applies_to_price_ids": "<any>"
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<any>",
                "filters": "<any>",
                "applies_to_price_ids": "<any>"
              },
              "maximum_amount": "<string>",
              "adjustments": [
                "<any>"
              ],
              "name": "Fixed Fee",
              "quantity": 1,
              "start_date": "2022-02-01T08:00:00+00:00",
              "subtotal": "9.00",
              "adjusted_subtotal": "5.00",
              "credits_applied": "6.00",
              "partially_invoiced_amount": "4.00",
              "sub_line_items": [
                "<any>"
              ],
              "tax_amounts": [
                "<any>"
              ],
              "id": "<string>",
              "price": {
                "model_type": "<any>",
                "unit_config": "<any>",
                "metadata": "<any>",
                "id": "<any>",
                "name": "<any>",
                "external_price_id": "<any>",
                "replaces_price_id": "<any>",
                "price_type": "<any>",
                "created_at": "<any>",
                "cadence": "<any>",
                "billing_mode": "<any>",
                "billing_cycle_configuration": "<any>",
                "invoicing_cycle_configuration": "<any>",
                "billable_metric": "<any>",
                "dimensional_price_configuration": "<any>",
                "fixed_price_quantity": "<any>",
                "plan_phase_order": "<any>",
                "currency": "<any>",
                "conversion_rate": "<any>",
                "conversion_rate_config": "<any>",
                "item": "<any>",
                "credit_allocation": "<any>",
                "composite_price_filters": "<any>",
                "discount": "<any>",
                "minimum": "<any>",
                "minimum_amount": "<any>",
                "maximum": "<any>",
                "maximum_amount": "<any>"
              },
              "usage_customer_ids": [
                "<any>"
              ],
              "filter": "<string>"
            }
          ],
          "subtotal": "8.00",
          "invoice_date": "2022-05-01T07:00:00+00:00",
          "is_payable_now": true
        }
      ],
      "voided_invoices": [
        {
          "metadata": {},
          "voided_at": "2023-11-07T05:31:56Z",
          "paid_at": "2023-11-07T05:31:56Z",
          "issued_at": "2023-11-07T05:31:56Z",
          "scheduled_issue_at": "2023-11-07T05:31:56Z",
          "auto_collection": {
            "next_attempt_at": "2023-11-07T05:31:56Z",
            "previously_attempted_at": "2023-11-07T05:31:56Z",
            "enabled": true,
            "num_attempts": 123
          },
          "issue_failed_at": "2023-11-07T05:31:56Z",
          "sync_failed_at": "2023-11-07T05:31:56Z",
          "payment_failed_at": "2023-11-07T05:31:56Z",
          "payment_started_at": "2023-11-07T05:31:56Z",
          "amount_due": "8.00",
          "created_at": "2022-05-01T07:01:31+00:00",
          "currency": "USD",
          "customer": {
            "id": "<string>",
            "external_customer_id": "<string>"
          },
          "due_date": "2022-05-30T07:00:00+00:00",
          "id": "<string>",
          "invoice_pdf": "https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb",
          "invoice_number": "JYEFHK-00001",
          "subscription": {
            "id": "VDGsT23osdLb84KD"
          },
          "total": "8.00",
          "customer_balance_transactions": [
            {
              "id": "cgZa3SXcsPTVyC4Y",
              "created_at": "2022-05-01T07:01:31+00:00",
              "starting_balance": "33.00",
              "ending_balance": "22.00",
              "amount": "11.00",
              "action": "applied_to_invoice",
              "description": "An optional description",
              "invoice": {
                "id": "<any>"
              },
              "type": "increment",
              "credit_note": {
                "id": "<any>"
              }
            }
          ],
          "status": "issued",
          "invoice_source": "subscription",
          "shipping_address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          },
          "billing_address": {
            "line1": "<string>",
            "line2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postal_code": "<string>",
            "country": "<string>"
          },
          "hosted_invoice_url": "<string>",
          "will_auto_issue": true,
          "eligible_to_issue_at": "2023-11-07T05:31:56Z",
          "customer_tax_id": {
            "country": "AD",
            "type": "ad_nrt",
            "value": "<string>"
          },
          "memo": "<string>",
          "credit_notes": [
            {
              "id": "<string>",
              "credit_note_number": "<string>",
              "reason": "<string>",
              "total": "<string>",
              "voided_at": "2022-05-01T07:01:31+00:00",
              "type": "<string>",
              "memo": "<string>"
            }
          ],
          "payment_attempts": [
            {
              "id": "<string>",
              "payment_provider": "stripe",
              "payment_provider_id": "<string>",
              "amount": "<string>",
              "succeeded": true,
              "created_at": "2023-11-07T05:31:56Z",
              "receipt_pdf": "https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
            }
          ],
          "discount": "<any>",
          "discounts": [
            {
              "discount_type": "<any>",
              "applies_to_price_ids": "<any>",
              "filters": "<any>",
              "reason": "<any>",
              "percentage_discount": "<any>"
            }
          ],
          "minimum": {
            "minimum_amount": "<any>",
            "filters": "<any>",
            "applies_to_price_ids": "<any>"
          },
          "minimum_amount": "<string>",
          "maximum": {
            "maximum_amount": "<any>",
            "filters": "<any>",
            "applies_to_price_ids": "<any>"
          },
          "maximum_amount": "<string>",
          "line_items": [
            {
              "amount": "7.00",
              "discount": {},
              "end_date": "2022-02-01T08:00:00+00:00",
              "grouping": "<string>",
              "minimum": {
                "minimum_amount": "<any>",
                "filters": "<any>",
                "applies_to_price_ids": "<any>"
              },
              "minimum_amount": "<string>",
              "maximum": {
                "maximum_amount": "<any>",
                "filters": "<any>",
                "applies_to_price_ids": "<any>"
              },
              "maximum_amount": "<string>",
              "adjustments": [
                "<any>"
              ],
              "name": "Fixed Fee",
              "quantity": 1,
              "start_date": "2022-02-01T08:00:00+00:00",
              "subtotal": "9.00",
              "adjusted_subtotal": "5.00",
              "credits_applied": "6.00",
              "partially_invoiced_amount": "4.00",
              "sub_line_items": [
                "<any>"
              ],
              "tax_amounts": [
                "<any>"
              ],
              "id": "<string>",
              "price": {
                "model_type": "<any>",
                "unit_config": "<any>",
                "metadata": "<any>",
                "id": "<any>",
                "name": "<any>",
                "external_price_id": "<any>",
                "replaces_price_id": "<any>",
                "price_type": "<any>",
                "created_at": "<any>",
                "cadence": "<any>",
                "billing_mode": "<any>",
                "billing_cycle_configuration": "<any>",
                "invoicing_cycle_configuration": "<any>",
                "billable_metric": "<any>",
                "dimensional_price_configuration": "<any>",
                "fixed_price_quantity": "<any>",
                "plan_phase_order": "<any>",
                "currency": "<any>",
                "conversion_rate": "<any>",
                "conversion_rate_config": "<any>",
                "item": "<any>",
                "credit_allocation": "<any>",
                "composite_price_filters": "<any>",
                "discount": "<any>",
                "minimum": "<any>",
                "minimum_amount": "<any>",
                "maximum": "<any>",
                "maximum_amount": "<any>"
              },
              "usage_customer_ids": [
                "<any>"
              ],
              "filter": "<string>"
            }
          ],
          "subtotal": "8.00",
          "invoice_date": "2022-05-01T07:00:00+00:00"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
subscription_change_id
string
required

Body

application/json
​
previously_collected_amount
string | null

Amount already collected to apply to the customer's balance. If mark_as_paid is also provided, credit the difference to the customer's balance.

​
mark_as_paid
boolean | null

Mark all pending invoices that are payable as paid. If amount is also provided, mark as paid and credit the difference to the customer's balance.

​
description
string | null

Description to apply to the balance transaction representing this credit.

​
payment_received_date
string<date> | null

A date string to specify the date the payment was received. Only applicable when mark_as_paid is true. If not provided, defaults to the current date.

​
payment_external_id
string | null

An optional external ID to associate with the payment. Only applicable when mark_as_paid is true.

​
payment_notes
string | null

Optional notes about the payment. Only applicable when mark_as_paid is true.

Response

OK

A subscription change represents a desired new subscription / pending change to an existing subscription. It is a way to first preview the effects on the subscription as well as any changes/creation of invoices (see subscription.changed_resources).

​
id
string
required
​
status
enum<string>
required
Available options:
pending,
applied,
cancelled
​
expiration_time
string<date-time>
required

Subscription change will be cancelled at this time and can no longer be applied.

​
subscription
object | null
required
​
applied_at
string<date-time> | null

When this change was applied.

​
cancelled_at
string<date-time> | null

When this change was cancelled.