PayPal-PHP-Server-SDK/doc/models/capture-subscription-request.md

Capture Subscription Request

The charge amount from the subscriber.

Structure

CaptureSubscriptionRequest

Fields

Name	Type	Tags	Description	Getter	Setter
note	string	Required	The reason or note for the subscription charge. Constraints: Minimum Length: 1, Maximum Length: 128, Pattern: ^.*$	getNote(): string	setNote(string note): void
captureType	string(CaptureType)	Required	The type of capture. Constraints: Minimum Length: 1, Maximum Length: 24, Pattern: ^[A-Z_]+$	getCaptureType(): string	setCaptureType(string captureType): void
amount	Money	Required	The currency and amount for a financial transaction, such as a balance or payment due.	getAmount(): Money	setAmount(Money amount): void

Example (as JSON)

{
  "note": "note4",
  "capture_type": "OUTSTANDING_BALANCE",
  "amount": {
    "currency_code": "currency_code6",
    "value": "value0"
  }
}