1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. updateOffer

Commerce

updateOffer

Update Offer

Update an Offer's name, description, or pricing.

write

Arguments

• offerIdstringrequiredThe offer ID.
• namestringoptionalNo description is declared in the tool schema.
• descriptionstringoptionalNo description is declared in the tool schema.
• kindstringoptionalAllowed values: one_time, subscription, installment.
• amountCentsintegeroptionalNo description is declared in the tool schema.
• currencystringoptionalNo description is declared in the tool schema.
• intervalstringoptionalAllowed values: day, week, month, year.
• intervalCountintegeroptionalIntervals between charges. Unit-specific maximum is 3 years.
• installmentCountintegeroptionalNo description is declared in the tool schema.
• trialDaysintegeroptionalNo description is declared in the tool schema.

Returns

The registry does not declare a return shape.

Declared limits

• amountCents: greater than 0
• amountCents: maximum 9007199254740991
• intervalCount: greater than 0
• intervalCount: maximum 1095
• installmentCount: greater than 0
• installmentCount: maximum 9007199254740991
• trialDays: minimum 0
• trialDays: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

• change the Library Card to $12
• rename that offer

Pair it with

The verbs that finish the job.

• getOffer