Back to Pipedrive OauthUpdate a recurring subscription
Updates a recurring subscription.
Input
type: object
properties:
parameters:
type: object
properties:
id:
type: integer
description: The ID of the subscription
required:
- id
data:
title: updateRecurringSubscriptionRequest
type: object
required:
- id
- effective_date
properties:
description:
type: string
description: The description of the recurring subscription
cycle_amount:
type: integer
description: The amount of each payment
payments:
type: array
description: >-
Array of additional payments. It requires a minimum structure as
follows: [{ amount:SUM, description:DESCRIPTION, due_at:PAYMENT_DATE
}]. Replace SUM with a payment amount, DESCRIPTION with an explanation
string, PAYMENT_DATE with a date (format YYYY-MM-DD).
items:
type: object
update_deal_value:
type: boolean
description: >-
Indicates that the deal value must be set to recurring subscription's
MRR value
effective_date:
type: string
format: date
description: 'All payments after that date will be affected. Format: YYYY-MM-DD'
Output
title: subscriptionsIdResponse200
type: object
properties:
success:
type: boolean
description: If the response is successful or not
data:
type: object
properties:
id:
type: integer
description: The ID of the subscription
user_id:
type: integer
description: The ID of the user who created the subscription
deal_id:
type: integer
description: The ID of the deal this subscription is associated with
description:
type: string
description: The description of the recurring subscription
is_active:
type: boolean
description: The subscription status
cycles_count:
type: integer
description: Shows how many payments a recurring subscription has
cycle_amount:
type: integer
description: The amount of each payment
infinite:
type: boolean
description: >-
Indicates that the recurring subscription will last until it is
manually canceled or deleted
currency:
type: string
description: The currency of the subscription
cadence_type:
type: string
description: The interval between payments
start_date:
type: string
format: date
description: The start date of the recurring subscription
end_date:
type: string
format: date
description: The end date of the subscription
lifetime_value:
type: number
format: double
description: The total value of all payments
final_status:
type: string
nullable: true
description: The final status of the subscription
add_time:
type: string
format: datetime
description: The creation time of the subscription
update_time:
type: string
format: datetime
description: The update time of the subscription